diff --git a/citing.html b/citing.html index d36816fba50..d5df7d2c979 100644 --- a/citing.html +++ b/citing.html @@ -1,4 +1,4 @@ -Citing Zapdos and MOOSE|Zapdos

Code Documentation

Application Development

Questions and General Information

Developer Information (from MOOSE website)

Citing Zapdos and MOOSE

Application

If you use Zapdos for your publication, please cite the following:


+Citing Zapdos and MOOSE|Zapdos
Code Documentation
Application Development
Questions and General Information
Developer Information (from MOOSE website)
Citing Zapdos and MOOSE
Application
If you use Zapdos for your publication, please cite the following:

 @Article{zapdos-paper,
   author = {Alexander D Lindsay and David B Graves and Steven C Shannon},
   title = {Fully coupled simulation of the plasma liquid interface and interfacial coefficient effects},
@@ -9,4 +9,4 @@
   pages = {235204},
   note = {\url{http://dx.doi.org/10.1088/0022-3727/49/23/235204}}
 }
-
MOOSE Framework
Please see Citing MOOSE on the main MOOSE Framework website for the most current citations. 

\ No newline at end of file
+

MOOSE Framework

Please see Citing MOOSE on the main MOOSE Framework website for the most current citations.

\ No newline at end of file diff --git a/css/alert_moose.css b/css/alert_moose.css index 936e5264644..91cdd70b6f3 100644 --- a/css/alert_moose.css +++ b/css/alert_moose.css @@ -1,12 +1,12 @@ :root { --alert-error: rgba(153, 0, 0, 1.0); - --alert-error-content: rgba(153, 0, 0, 0.1); + --alert-error-content: rgba(153, 0, 0, 0.2); --alert-note: rgba(0, 88, 151, 1.0); - --alert-note-content: rgba(0, 88, 151, 0.1); + --alert-note-content: rgba(0, 88, 151, 0.2); --alert-warning: rgba(255, 255, 51, 1.0); - --alert-warning-content: rgba(255, 255, 51, 0.1); + --alert-warning-content: rgba(255, 255, 51, 0.2); --alert-construction: rgba(255, 114, 33, 1.0); - --alert-construction-content: rgba(255, 114, 33, 0.1); + --alert-construction-content: rgba(255, 114, 33, 0.2); } .moose-alert-title a{ diff --git a/css/moose.css b/css/moose.css index b9736c9fbbb..7a5baa03265 100644 --- a/css/moose.css +++ b/css/moose.css @@ -306,6 +306,10 @@ ul { margin: 0; } +.modal-content.container.moose-search-modal-content{ + padding:0; +} + /* NAME/HOME link */ .moose-logo{ margin-right:30px; @@ -805,9 +809,6 @@ li p { display:table-row; } */ -.card .card-title{ - margin-left: 6px; -} .moose-error, .moose-katex-error{ diff --git a/documentation.menu.html b/documentation.menu.html index ab84356e9c9..611fdd312fb 100644 --- a/documentation.menu.html +++ b/documentation.menu.html @@ -1 +1 @@ -Code Documentation|Zapdos

Code Documentation

Application Development

Questions and General Information

Developer Information (from MOOSE website)

Code Documentation

Application Development

    \ No newline at end of file +Code Documentation|Zapdos

    Code Documentation

    Application Development

    Questions and General Information

    Developer Information (from MOOSE website)

    Code Documentation

    Application Development

      \ No newline at end of file diff --git a/getting_started/index.html b/getting_started/index.html index 7698b9f607c..49c2acbc69b 100644 --- a/getting_started/index.html +++ b/getting_started/index.html @@ -1,7 +1,7 @@ -Getting Started|Zapdos

      Code Documentation

      Application Development

      Questions and General Information

      Developer Information (from MOOSE website)

      Getting Started

      Install and Test MOOSE

      First you will need to install the MOOSE Environment. To do this, proceed to the MOOSE Getting Started pages. After successfully obtaining a working MOOSE Environment, return to this page to continue.

      note

      These instructions will assume that you are working in the ~/projects directory, which is consistent with the MOOSE installation instructions.

      Build and Test Zapdos

      To download Zapdos, do the following:

      
+Getting Started|Zapdos
      Code Documentation
      Application Development
      Questions and General Information
      Developer Information (from MOOSE website)
      Getting Started
      Install and Test MOOSE
      First you will need to install the MOOSE Environment. To do this, proceed to the MOOSE Getting Started pages. After successfully obtaining a working MOOSE Environment, return to this page to continue.
      note
      These instructions will assume that you are working in the ~/projects directory, which is consistent with the MOOSE installation instructions.
      Build and Test Zapdos
      To download Zapdos, do the following:
      
 cd ~/projects
 git clone https://github.com/shannon-lab/zapdos
-
      Note that Zapdos can be used with MOOSE installed in its own directory, or as a submodule within Zapdos. The latter option allows for a version of MOOSE that is guaranteed to work with the current version of Zapdos. Instructions for each option is provided below.
      Using MOOSE as a Zapdos submodule
      To use MOOSE as a Zapdos submodule, do the following:
      
+
      Note that Zapdos can be used with MOOSE installed in its own directory, or as a submodule within Zapdos. The latter option allows for a version of MOOSE that is guaranteed to work with the current version of Zapdos. Instructions for each option is provided below.
      Using MOOSE as a Zapdos submodule
      To use MOOSE as a Zapdos submodule, do the following:
      
 cd zapdos
 git submodule init
 git submodule update
@@ -14,7 +14,7 @@
 cd ~/projects/zapdos
 make -j4
 ./run_tests -j4
-
      If Zapdos is working correctly, all active tests will pass. This indicates that Zapdos is ready to be used and further developed.
      Using MOOSE in its own directory
      To use MOOSE in its own directory:
      
+
      If Zapdos is working correctly, all active tests will pass. This indicates that Zapdos is ready to be used and further developed.
      Using MOOSE in its own directory
      To use MOOSE in its own directory:
      
 cd ~/projects
 git clone https://github.com/idaholab/moose
 cd moose
@@ -28,7 +28,7 @@
 git submodule update squirrel crane
 make -j4
 ./run_tests -j4
-
      If Zapdos is working correctly, all active tests will pass. This indicates that Zapdos is ready to be used and further developed.
      How to Proceed
      After testng is complete, you should now be able to run input files using the zapdos-opt executable in the ~/projects/zapdos directory. Input files demonstrating the capabilities of Zapdos can be found in the sub-directories of ~/projects/zapdos/tests. If you want to start modifying an input file, a good one to choose is mean_en.i in ~/projects/zapdos/problems. A typical command to run a Zapdos input file is as follows:
      
+
      If Zapdos is working correctly, all active tests will pass. This indicates that Zapdos is ready to be used and further developed.
      How to Proceed
      After testng is complete, you should now be able to run input files using the zapdos-opt executable in the ~/projects/zapdos directory. Input files demonstrating the capabilities of Zapdos can be found in the sub-directories of ~/projects/zapdos/tests. If you want to start modifying an input file, a good one to choose is mean_en.i in ~/projects/zapdos/problems. A typical command to run a Zapdos input file is as follows:
      
 cd ~/projects/zapdos/problems
 ../zapdos-opt -i mean_en.i --color off 2>&1 | tee log.txt
-
      The above command will parse information of the iterative solution process to both the console and to the log file log.txt. It will also create an output file named mean_en_out.e containing all the solution variable values. These results are best viewed using a visualization tool like Paraview, downloadable here.
      note
      Many of the existing input files in the problems directory require fileName.msh. In order to create the requisite .msh file, you must run the command gmsh -d fileName.geo where d is the dimensionality (1, 2, or 3) of the mesh and fileName.geo is the source file for the mesh. gmsh can be downloaded here. Some of the *.msh files can also be found in the tests directory.
      In general the problems directory is meant to be the user work-space. S/he should feel welcome to modify any files in that directory. The tests directory, on the other hand, is meant to be a showcase and provide examples of the capabilities already established in Zapdos. As Zapdos is developed (by you hopefully!) and more capabilities are added, the tests directory will continue to grow. If you feel that you have added important new functionality, please create a test for it, such that any future changes will not break that capability.
      Troubleshooting
      Please see the MOOSE FAQ page for general troubleshooting information for the framework. If your issue is not listed among the FAQs, please refer to the Zapdos Mailing List or the MOOSE Mailing List. 
      
\ No newline at end of file
+

      The above command will parse information of the iterative solution process to both the console and to the log file log.txt. It will also create an output file named mean_en_out.e containing all the solution variable values. These results are best viewed using a visualization tool like Paraview, downloadable here.

      note

      Many of the existing input files in the problems directory require fileName.msh. In order to create the requisite .msh file, you must run the command gmsh -d fileName.geo where d is the dimensionality (1, 2, or 3) of the mesh and fileName.geo is the source file for the mesh. gmsh can be downloaded here. Some of the *.msh files can also be found in the tests directory.

      In general the problems directory is meant to be the user work-space. S/he should feel welcome to modify any files in that directory. The tests directory, on the other hand, is meant to be a showcase and provide examples of the capabilities already established in Zapdos. As Zapdos is developed (by you hopefully!) and more capabilities are added, the tests directory will continue to grow. If you feel that you have added important new functionality, please create a test for it, such that any future changes will not break that capability.

      Troubleshooting

      Please see the MOOSE FAQ page for general troubleshooting information for the framework. If your issue is not listed among the FAQs, please refer to the Zapdos Mailing List or the MOOSE Mailing List.

      \ No newline at end of file diff --git a/help.menu.html b/help.menu.html index db03d8581d2..f0eda016559 100644 --- a/help.menu.html +++ b/help.menu.html @@ -1 +1 @@ -Questions and General Information|Zapdos

      Code Documentation

      Application Development

      Questions and General Information

      Developer Information (from MOOSE website)

      Questions and General Information

      Developer Information (from MOOSE website)

        \ No newline at end of file +Questions and General Information|Zapdos

        Code Documentation

        Application Development

        Questions and General Information

        Developer Information (from MOOSE website)

        Questions and General Information

        Developer Information (from MOOSE website)

          \ No newline at end of file diff --git a/help/a-to-z.html b/help/a-to-z.html index 0b22b59ced8..f8d5b947321 100644 --- a/help/a-to-z.html +++ b/help/a-to-z.html @@ -1 +1 @@ -a-to-z.md|Zapdos

          Code Documentation

          Application Development

          Questions and General Information

          Developer Information (from MOOSE website)

          0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ

          a

          b

          c

          d

          e

          f

              g

              h

              i

              j

                k

                    l

                    m

                      n

                        p

                        q

                            r

                              s

                              t

                              u

                              w

                                  \ No newline at end of file +a-to-z.md|Zapdos

                                  Code Documentation

                                  Application Development

                                  Questions and General Information

                                  Developer Information (from MOOSE website)

                                  0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ

                                  a

                                  b

                                  c

                                  d

                                  e

                                  f

                                      g

                                      h

                                      i

                                      j

                                        k

                                            l

                                            m

                                              n

                                                p

                                                q

                                                    r

                                                      s

                                                      t

                                                      u

                                                      w

                                                          \ No newline at end of file diff --git a/index.html b/index.html index 4903ec99668..ed5fc92f4d4 100644 --- a/index.html +++ b/index.html @@ -1 +1 @@ -HOME|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HOME

                                                          Zapdos

                                                          An open source MOOSE Framework application for the simulation of plasmas

                                                          flash_on

                                                          Rapid Development

                                                          Zapdos, through the MOOSE Framework, provides a plug-in infrastructure that simplifies definitions of physics, material properties, and postprocessing.

                                                          group

                                                          User Focused

                                                          Zapdos supports multi-scale models, enabling collaboration across applications, time-scales, and spatial domains.

                                                          settings

                                                          Getting Started

                                                          Zapdos works on Mac OS, Linux, and Windows and is easy to get started with. Begin by exploring our getting started page.

                                                          \ No newline at end of file +HOME|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HOME

                                                          Zapdos

                                                          An open source MOOSE Framework application for the simulation of plasmas

                                                          flash_on

                                                          Rapid Development

                                                          Zapdos, through the MOOSE Framework, provides a plug-in infrastructure that simplifies definitions of physics, material properties, and postprocessing.

                                                          group

                                                          User Focused

                                                          Zapdos supports multi-scale models, enabling collaboration across applications, time-scales, and spatial domains.

                                                          settings

                                                          Getting Started

                                                          Zapdos works on Mac OS, Linux, and Windows and is easy to get started with. Begin by exploring our getting started page.

                                                          Department of Nuclear Engineering

                                                          4-STAR Research Group

                                                          Collaborators

                                                          Laboratory of Computational Plasma Physics

                                                          Go Research Group

                                                          Graves Lab

                                                          Fusion Energy Division

                                                          Funding Acknowledgements

                                                          Office of Science Graduate Student Research Program Nuclear Energy University Program

                                                          SI2-SSE Award #1740300

                                                          INL Graduate Fellowship Program

                                                          \ No newline at end of file diff --git a/js/search_index.js b/js/search_index.js index 4c66b4b1497..8ba67a023d0 100644 --- a/js/search_index.js +++ b/js/search_index.js @@ -1 +1 @@ -var index_data = [{"text": "DGEFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGEFieldAdvection.html#dgefieldadvection", "title": "DGEFieldAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGEFieldAdvection.html#input-parameters", "title": "DGEFieldAdvection"}, {"text": "EFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvection.html#efieldadvection", "title": "EFieldAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvection.html#input-parameters", "title": "EFieldAdvection"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvection.html#input-files", "title": "EFieldAdvection"}, {"text": "AddLotsOfSources", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfSources.html#addlotsofsources", "title": "AddLotsOfSources"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfSources.html#input-parameters", "title": "AddLotsOfSources"}, {"text": "UserObjects System", "location": "https://shannon-lab.github.io/zapdos/syntax/UserObjects/index.html#userobjects-system", "title": "UserObjects System"}, {"text": "HagelaarElectronAdvectionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronAdvectionBC.html#hagelaarelectronadvectionbc", "title": "HagelaarElectronAdvectionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronAdvectionBC.html#input-parameters", "title": "HagelaarElectronAdvectionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronAdvectionBC.html#input-files", "title": "HagelaarElectronAdvectionBC"}, {"text": "DriftDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusion.html#driftdiffusion", "title": "DriftDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusion.html#input-parameters", "title": "DriftDiffusion"}, {"text": "Child Objects", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusion.html#child-objects", "title": "DriftDiffusion"}, {"text": "ElectronTimeDerivative", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronTimeDerivative.html#electrontimederivative", "title": "ElectronTimeDerivative"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronTimeDerivative.html#input-parameters", "title": "ElectronTimeDerivative"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronTimeDerivative.html#input-files", "title": "ElectronTimeDerivative"}, {"text": "ElectronEnergyLossFromElastic", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromElastic.html#electronenergylossfromelastic", "title": "ElectronEnergyLossFromElastic"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromElastic.html#input-parameters", "title": "ElectronEnergyLossFromElastic"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromElastic.html#input-files", "title": "ElectronEnergyLossFromElastic"}, {"text": "ElectronEnergyTermElasticRate", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermElasticRate.html#electronenergytermelasticrate", "title": "ElectronEnergyTermElasticRate"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermElasticRate.html#input-parameters", "title": "ElectronEnergyTermElasticRate"}, {"text": "ElectronTemperature", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ElectronTemperature.html#electrontemperature", "title": "ElectronTemperature"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ElectronTemperature.html#input-parameters", "title": "ElectronTemperature"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ElectronTemperature.html#input-files", "title": "ElectronTemperature"}, {"text": "TM 0 Cylindrical", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0Cylindrical.html#tm-0-cylindrical", "title": "TM 0 Cylindrical"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0Cylindrical.html#input-parameters", "title": "TM 0 Cylindrical"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0Cylindrical.html#input-files", "title": "TM 0 Cylindrical"}, {"text": "CoeffDiffusionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionElectrons.html#coeffdiffusionelectrons", "title": "CoeffDiffusionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionElectrons.html#input-parameters", "title": "CoeffDiffusionElectrons"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionElectrons.html#input-files", "title": "CoeffDiffusionElectrons"}, {"text": "TotalFlux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TotalFlux.html#totalflux", "title": "TotalFlux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TotalFlux.html#input-parameters", "title": "TotalFlux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TotalFlux.html#input-files", "title": "TotalFlux"}, {"text": "Getting Started", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#getting-started", "title": "Getting Started"}, {"text": "Install and Test MOOSE", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#install-and-test-moose", "title": "Getting Started"}, {"text": "Build and Test Zapdos", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#build-and-test-zapdos", "title": "Getting Started"}, {"text": "Using MOOSE as a Zapdos submodule", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#using-moose-as-a-zapdos-submodule", "title": "Getting Started"}, {"text": "Using MOOSE in its own directory", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#using-moose-in-its-own-directory", "title": "Getting Started"}, {"text": "How to Proceed", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#how-to-proceed", "title": "Getting Started"}, {"text": "Troubleshooting", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#troubleshooting", "title": "Getting Started"}, {"text": "Source Documentation", "location": "https://shannon-lab.github.io/zapdos/source/index.html#source-documentation", "title": "Source Documentation"}, {"text": "AnalyticalDiffIndicator", "location": "https://shannon-lab.github.io/zapdos/source/indicators/AnalyticalDiffIndicator.html#analyticaldiffindicator", "title": "AnalyticalDiffIndicator"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/indicators/AnalyticalDiffIndicator.html#input-parameters", "title": "AnalyticalDiffIndicator"}, {"text": "ElectronEnergyLossFromIonization", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromIonization.html#electronenergylossfromionization", "title": "ElectronEnergyLossFromIonization"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromIonization.html#input-parameters", "title": "ElectronEnergyLossFromIonization"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromIonization.html#input-files", "title": "ElectronEnergyLossFromIonization"}, {"text": "AxisymmetricCurlZ", "location": "https://shannon-lab.github.io/zapdos/source/kernels/AxisymmetricCurlZ.html#axisymmetriccurlz", "title": "AxisymmetricCurlZ"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/AxisymmetricCurlZ.html#input-parameters", "title": "AxisymmetricCurlZ"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/AxisymmetricCurlZ.html#input-files", "title": "AxisymmetricCurlZ"}, {"text": "LymberopoulosElectronBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosElectronBC.html#lymberopouloselectronbc", "title": "LymberopoulosElectronBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosElectronBC.html#input-parameters", "title": "LymberopoulosElectronBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosElectronBC.html#input-files", "title": "LymberopoulosElectronBC"}, {"text": "ElectronTemperatureDirichletBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronTemperatureDirichletBC.html#electrontemperaturedirichletbc", "title": "ElectronTemperatureDirichletBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronTemperatureDirichletBC.html#input-parameters", "title": "ElectronTemperatureDirichletBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronTemperatureDirichletBC.html#input-files", "title": "ElectronTemperatureDirichletBC"}, {"text": "AddLotsOfTimeDerivatives", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfTimeDerivatives.html#addlotsoftimederivatives", "title": "AddLotsOfTimeDerivatives"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfTimeDerivatives.html#input-parameters", "title": "AddLotsOfTimeDerivatives"}, {"text": "LymberopoulosIonBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosIonBC.html#lymberopoulosionbc", "title": "LymberopoulosIonBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosIonBC.html#input-parameters", "title": "LymberopoulosIonBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosIonBC.html#input-files", "title": "LymberopoulosIonBC"}, {"text": "DensityMoles", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DensityMoles.html#densitymoles", "title": "DensityMoles"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DensityMoles.html#input-parameters", "title": "DensityMoles"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DensityMoles.html#input-files", "title": "DensityMoles"}, {"text": "ProductAABBRxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductAABBRxn.html#productaabbrxn", "title": "ProductAABBRxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductAABBRxn.html#input-parameters", "title": "ProductAABBRxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductAABBRxn.html#input-files", "title": "ProductAABBRxn"}, {"text": "HeavySpecies", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpecies.html#heavyspecies", "title": "HeavySpecies"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpecies.html#input-parameters", "title": "HeavySpecies"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpecies.html#input-files", "title": "HeavySpecies"}, {"text": "EFieldMagnitudeSource", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldMagnitudeSource.html#efieldmagnitudesource", "title": "EFieldMagnitudeSource"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldMagnitudeSource.html#input-parameters", "title": "EFieldMagnitudeSource"}, {"text": "ChargeSourceMoles KV", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ChargeSourceMoles_KV.html#chargesourcemoles-kv", "title": "ChargeSourceMoles KV"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ChargeSourceMoles_KV.html#input-parameters", "title": "ChargeSourceMoles KV"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ChargeSourceMoles_KV.html#input-files", "title": "ChargeSourceMoles KV"}, {"text": "HagelaarEnergyAdvectionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyAdvectionBC.html#hagelaarenergyadvectionbc", "title": "HagelaarEnergyAdvectionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyAdvectionBC.html#input-parameters", "title": "HagelaarEnergyAdvectionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyAdvectionBC.html#input-files", "title": "HagelaarEnergyAdvectionBC"}, {"text": "DriftDiffusionUserDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionUserDoNothingBC.html#driftdiffusionuserdonothingbc", "title": "DriftDiffusionUserDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionUserDoNothingBC.html#input-parameters", "title": "DriftDiffusionUserDoNothingBC"}, {"text": "ElectronsFromIonization", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#electronsfromionization", "title": "ElectronsFromIonization"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#input-parameters", "title": "ElectronsFromIonization"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#input-files", "title": "ElectronsFromIonization"}, {"text": "Child Objects", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#child-objects", "title": "ElectronsFromIonization"}, {"text": "DriftDiffusionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionElectrons.html#driftdiffusionelectrons", "title": "DriftDiffusionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionElectrons.html#input-parameters", "title": "DriftDiffusionElectrons"}, {"text": "AddLotsOfEFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfEFieldAdvection.html#addlotsofefieldadvection", "title": "AddLotsOfEFieldAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfEFieldAdvection.html#input-parameters", "title": "AddLotsOfEFieldAdvection"}, {"text": "AddLotsOfVariables", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfVariables.html#addlotsofvariables", "title": "AddLotsOfVariables"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfVariables.html#input-parameters", "title": "AddLotsOfVariables"}, {"text": "Postprocessors System", "location": "https://shannon-lab.github.io/zapdos/syntax/Postprocessors/index.html#postprocessors-system", "title": "Postprocessors System"}, {"text": "CoeffDiffusionLin", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionLin.html#coeffdiffusionlin", "title": "CoeffDiffusionLin"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionLin.html#input-parameters", "title": "CoeffDiffusionLin"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionLin.html#input-files", "title": "CoeffDiffusionLin"}, {"text": "HagelaarEnergyBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyBC.html#hagelaarenergybc", "title": "HagelaarEnergyBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyBC.html#input-parameters", "title": "HagelaarEnergyBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyBC.html#input-files", "title": "HagelaarEnergyBC"}, {"text": "CoeffDiffusionEnergy", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionEnergy.html#coeffdiffusionenergy", "title": "CoeffDiffusionEnergy"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionEnergy.html#input-parameters", "title": "CoeffDiffusionEnergy"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionEnergy.html#input-files", "title": "CoeffDiffusionEnergy"}, {"text": "TM 0 CylindricalEz", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEz.html#tm-0-cylindricalez", "title": "TM 0 CylindricalEz"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEz.html#input-parameters", "title": "TM 0 CylindricalEz"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEz.html#input-files", "title": "TM 0 CylindricalEz"}, {"text": "HagelaarIonAdvectionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonAdvectionBC.html#hagelaarionadvectionbc", "title": "HagelaarIonAdvectionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonAdvectionBC.html#input-parameters", "title": "HagelaarIonAdvectionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonAdvectionBC.html#input-files", "title": "HagelaarIonAdvectionBC"}, {"text": "DriftDiffusionEnergy", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionEnergy.html#driftdiffusionenergy", "title": "DriftDiffusionEnergy"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionEnergy.html#input-parameters", "title": "DriftDiffusionEnergy"}, {"text": "NodeAndSidesetBetweenSubdomains", "location": "https://shannon-lab.github.io/zapdos/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html#nodeandsidesetbetweensubdomains", "title": "NodeAndSidesetBetweenSubdomains"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html#input-parameters", "title": "NodeAndSidesetBetweenSubdomains"}, {"text": "FieldEmissionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/FieldEmissionBC.html#fieldemissionbc", "title": "FieldEmissionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/FieldEmissionBC.html#input-parameters", "title": "FieldEmissionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/FieldEmissionBC.html#input-files", "title": "FieldEmissionBC"}, {"text": "Constraints System", "location": "https://shannon-lab.github.io/zapdos/syntax/Constraints/index.html#constraints-system", "title": "Constraints System"}, {"text": "PotentialDriftOutflowBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PotentialDriftOutflowBC.html#potentialdriftoutflowbc", "title": "PotentialDriftOutflowBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PotentialDriftOutflowBC.html#input-parameters", "title": "PotentialDriftOutflowBC"}, {"text": "LogDensityDirichletBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LogDensityDirichletBC.html#logdensitydirichletbc", "title": "LogDensityDirichletBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LogDensityDirichletBC.html#input-parameters", "title": "LogDensityDirichletBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LogDensityDirichletBC.html#input-files", "title": "LogDensityDirichletBC"}, {"text": "HagelaarElectronBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronBC.html#hagelaarelectronbc", "title": "HagelaarElectronBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronBC.html#input-parameters", "title": "HagelaarElectronBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronBC.html#input-files", "title": "HagelaarElectronBC"}, {"text": "Bounds System", "location": "https://shannon-lab.github.io/zapdos/syntax/Bounds/index.html#bounds-system", "title": "Bounds System"}, {"text": "EFieldAdvectionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionElectrons.html#efieldadvectionelectrons", "title": "EFieldAdvectionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionElectrons.html#input-parameters", "title": "EFieldAdvectionElectrons"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionElectrons.html#input-files", "title": "EFieldAdvectionElectrons"}, {"text": "DiffusiveFlux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DiffusiveFlux.html#diffusiveflux", "title": "DiffusiveFlux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DiffusiveFlux.html#input-parameters", "title": "DiffusiveFlux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DiffusiveFlux.html#input-files", "title": "DiffusiveFlux"}, {"text": "Citing Zapdos and MOOSE", "location": "https://shannon-lab.github.io/zapdos/citing.html#citing-zapdos-and-moose", "title": "Citing Zapdos and MOOSE"}, {"text": "Application", "location": "https://shannon-lab.github.io/zapdos/citing.html#application", "title": "Citing Zapdos and MOOSE"}, {"text": "MOOSE Framework", "location": "https://shannon-lab.github.io/zapdos/citing.html#moose-framework", "title": "Citing Zapdos and MOOSE"}, {"text": "ProcRateForRateCoeff", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeff.html#procrateforratecoeff", "title": "ProcRateForRateCoeff"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeff.html#input-parameters", "title": "ProcRateForRateCoeff"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeff.html#input-files", "title": "ProcRateForRateCoeff"}, {"text": "AddLotsOfPotentialDrivenArtificialDiff", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html#addlotsofpotentialdrivenartificialdiff", "title": "AddLotsOfPotentialDrivenArtificialDiff"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html#input-parameters", "title": "AddLotsOfPotentialDrivenArtificialDiff"}, {"text": "Kernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/Kernels/index.html#kernels-system", "title": "Kernels System"}, {"text": "SigmaMat", "location": "https://shannon-lab.github.io/zapdos/source/materials/SigmaMat.html#sigmamat", "title": "SigmaMat"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/SigmaMat.html#input-parameters", "title": "SigmaMat"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/SigmaMat.html#input-files", "title": "SigmaMat"}, {"text": "Questions and General Information", "location": "https://shannon-lab.github.io/zapdos/help.menu.html#questions-and-general-information", "title": null}, {"text": "Developer Information from MOOSE website", "location": "https://shannon-lab.github.io/zapdos/help.menu.html#developer-information-from-moose-website", "title": null}, {"text": "PlasmaFrequencyInverse", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/PlasmaFrequencyInverse.html#plasmafrequencyinverse", "title": "PlasmaFrequencyInverse"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/PlasmaFrequencyInverse.html#input-parameters", "title": "PlasmaFrequencyInverse"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/PlasmaFrequencyInverse.html#input-files", "title": "PlasmaFrequencyInverse"}, {"text": "Adaptivity System", "location": "https://shannon-lab.github.io/zapdos/syntax/Adaptivity/index.html#adaptivity-system", "title": "Adaptivity System"}, {"text": "ElectronEnergyLossFromExcitation", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromExcitation.html#electronenergylossfromexcitation", "title": "ElectronEnergyLossFromExcitation"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromExcitation.html#input-parameters", "title": "ElectronEnergyLossFromExcitation"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromExcitation.html#input-files", "title": "ElectronEnergyLossFromExcitation"}, {"text": "DriftDiffusionFluxAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DriftDiffusionFluxAux.html#driftdiffusionfluxaux", "title": "DriftDiffusionFluxAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DriftDiffusionFluxAux.html#input-parameters", "title": "DriftDiffusionFluxAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DriftDiffusionFluxAux.html#input-files", "title": "DriftDiffusionFluxAux"}, {"text": "LotsOfEFieldAdvection System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfEFieldAdvection/index.html#lotsofefieldadvection-system", "title": "LotsOfEFieldAdvection System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfEFieldAdvection/index.html#available-objects", "title": "LotsOfEFieldAdvection System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfEFieldAdvection/index.html#available-actions", "title": "LotsOfEFieldAdvection System"}, {"text": "AuxKernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/AuxKernels/index.html#auxkernels-system", "title": "AuxKernels System"}, {"text": "TM 0 PECVertBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0PECVertBC.html#tm-0-pecvertbc", "title": "TM 0 PECVertBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0PECVertBC.html#input-parameters", "title": "TM 0 PECVertBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0PECVertBC.html#input-files", "title": "TM 0 PECVertBC"}, {"text": "JouleHeating", "location": "https://shannon-lab.github.io/zapdos/source/kernels/JouleHeating.html#jouleheating", "title": "JouleHeating"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/JouleHeating.html#input-parameters", "title": "JouleHeating"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/JouleHeating.html#input-files", "title": "JouleHeating"}, {"text": "DriftDiffusionDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionDoNothingBC.html#driftdiffusiondonothingbc", "title": "DriftDiffusionDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionDoNothingBC.html#input-parameters", "title": "DriftDiffusionDoNothingBC"}, {"text": "Child Objects", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionDoNothingBC.html#child-objects", "title": "DriftDiffusionDoNothingBC"}, {"text": "Current", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Current.html#current", "title": "Current"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Current.html#input-parameters", "title": "Current"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Current.html#input-files", "title": "Current"}, {"text": "Complete Syntax", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#complete-syntax", "title": "Complete Syntax"}, {"text": "Adaptivity", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#adaptivity", "title": "Complete Syntax"}, {"text": "Adaptivity/Indicators", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#adaptivity/indicators", "title": "Complete Syntax"}, {"text": "AuxKernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#auxkernels", "title": "Complete Syntax"}, {"text": "BCs", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#bcs", "title": "Complete Syntax"}, {"text": "Bounds", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#bounds", "title": "Complete Syntax"}, {"text": "Constraints", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#constraints", "title": "Complete Syntax"}, {"text": "DGKernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#dgkernels", "title": "Complete Syntax"}, {"text": "InterfaceKernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#interfacekernels", "title": "Complete Syntax"}, {"text": "Kernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#kernels", "title": "Complete Syntax"}, {"text": "LotsOfCoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofcoeffdiffusion", "title": "Complete Syntax"}, {"text": "LotsOfEFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofefieldadvection", "title": "Complete Syntax"}, {"text": "LotsOfPotentialDrivenArtificialDiff", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofpotentialdrivenartificialdiff", "title": "Complete Syntax"}, {"text": "LotsOfSources", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofsources", "title": "Complete Syntax"}, {"text": "LotsOfTimeDerivatives", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsoftimederivatives", "title": "Complete Syntax"}, {"text": "LotsOfVariables", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofvariables", "title": "Complete Syntax"}, {"text": "Materials", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#materials", "title": "Complete Syntax"}, {"text": "MeshModifiers", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#meshmodifiers", "title": "Complete Syntax"}, {"text": "Postprocessors", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#postprocessors", "title": "Complete Syntax"}, {"text": "UserObjects", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#userobjects", "title": "Complete Syntax"}, {"text": "TM 0 CylindricalErAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalErAux.html#tm-0-cylindricaleraux", "title": "TM 0 CylindricalErAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalErAux.html#input-parameters", "title": "TM 0 CylindricalErAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalErAux.html#input-files", "title": "TM 0 CylindricalErAux"}, {"text": "TM 0 CylindricalEzAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalEzAux.html#tm-0-cylindricalezaux", "title": "TM 0 CylindricalEzAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalEzAux.html#input-parameters", "title": "TM 0 CylindricalEzAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalEzAux.html#input-files", "title": "TM 0 CylindricalEzAux"}, {"text": "Indicators System", "location": "https://shannon-lab.github.io/zapdos/syntax/Indicators/index.html#indicators-system", "title": "Indicators System"}, {"text": "Position", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Position.html#position", "title": "Position"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Position.html#input-parameters", "title": "Position"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Position.html#input-files", "title": "Position"}, {"text": "ProcRate", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRate.html#procrate", "title": "ProcRate"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRate.html#input-parameters", "title": "ProcRate"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRate.html#input-files", "title": "ProcRate"}, {"text": "CurrentDensityShapeSideUserObject", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/CurrentDensityShapeSideUserObject.html#currentdensityshapesideuserobject", "title": "CurrentDensityShapeSideUserObject"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/CurrentDensityShapeSideUserObject.html#input-parameters", "title": "CurrentDensityShapeSideUserObject"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/CurrentDensityShapeSideUserObject.html#input-files", "title": "CurrentDensityShapeSideUserObject"}, {"text": "LotsOfPotentialDrivenArtificialDiff System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfPotentialDrivenArtificialDiff/index.html#lotsofpotentialdrivenartificialdiff-system", "title": "LotsOfPotentialDrivenArtificialDiff System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfPotentialDrivenArtificialDiff/index.html#available-objects", "title": "LotsOfPotentialDrivenArtificialDiff System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfPotentialDrivenArtificialDiff/index.html#available-actions", "title": "LotsOfPotentialDrivenArtificialDiff System"}, {"text": "PenaltyCircuitPotential", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PenaltyCircuitPotential.html#penaltycircuitpotential", "title": "PenaltyCircuitPotential"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PenaltyCircuitPotential.html#input-parameters", "title": "PenaltyCircuitPotential"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PenaltyCircuitPotential.html#input-files", "title": "PenaltyCircuitPotential"}, {"text": "MeshModifiers System", "location": "https://shannon-lab.github.io/zapdos/syntax/MeshModifiers/index.html#meshmodifiers-system", "title": "MeshModifiers System"}, {"text": "CircuitDirichletPotential", "location": "https://shannon-lab.github.io/zapdos/source/bcs/CircuitDirichletPotential.html#circuitdirichletpotential", "title": "CircuitDirichletPotential"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/CircuitDirichletPotential.html#input-parameters", "title": "CircuitDirichletPotential"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/CircuitDirichletPotential.html#input-files", "title": "CircuitDirichletPotential"}, {"text": "TM 0 CylindricalEr", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEr.html#tm-0-cylindricaler", "title": "TM 0 CylindricalEr"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEr.html#input-parameters", "title": "TM 0 CylindricalEr"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEr.html#input-files", "title": "TM 0 CylindricalEr"}, {"text": "PotentialGradientSource", "location": "https://shannon-lab.github.io/zapdos/source/kernels/PotentialGradientSource.html#potentialgradientsource", "title": "PotentialGradientSource"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/PotentialGradientSource.html#input-parameters", "title": "PotentialGradientSource"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/PotentialGradientSource.html#input-files", "title": "PotentialGradientSource"}, {"text": "HeavySpeciesMaterial", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpeciesMaterial.html#heavyspeciesmaterial", "title": "HeavySpeciesMaterial"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpeciesMaterial.html#input-parameters", "title": "HeavySpeciesMaterial"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpeciesMaterial.html#input-files", "title": "HeavySpeciesMaterial"}, {"text": "LogStabilizationMoles", "location": "https://shannon-lab.github.io/zapdos/source/kernels/LogStabilizationMoles.html#logstabilizationmoles", "title": "LogStabilizationMoles"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/LogStabilizationMoles.html#input-parameters", "title": "LogStabilizationMoles"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/LogStabilizationMoles.html#input-files", "title": "LogStabilizationMoles"}, {"text": "EFieldAdvAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/EFieldAdvAux.html#efieldadvaux", "title": "EFieldAdvAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/EFieldAdvAux.html#input-parameters", "title": "EFieldAdvAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/EFieldAdvAux.html#input-files", "title": "EFieldAdvAux"}, {"text": "EFieldArtDiff", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldArtDiff.html#efieldartdiff", "title": "EFieldArtDiff"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldArtDiff.html#input-parameters", "title": "EFieldArtDiff"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldArtDiff.html#input-files", "title": "EFieldArtDiff"}, {"text": "SideTotFluxIntegral", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/SideTotFluxIntegral.html#sidetotfluxintegral", "title": "SideTotFluxIntegral"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/SideTotFluxIntegral.html#input-parameters", "title": "SideTotFluxIntegral"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/SideTotFluxIntegral.html#input-files", "title": "SideTotFluxIntegral"}, {"text": "DGKernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/DGKernels/index.html#dgkernels-system", "title": "DGKernels System"}, {"text": "ElectronsFromIonizationUser", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonizationUser.html#electronsfromionizationuser", "title": "ElectronsFromIonizationUser"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonizationUser.html#input-parameters", "title": "ElectronsFromIonizationUser"}, {"text": "DGCoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGCoeffDiffusion.html#dgcoeffdiffusion", "title": "DGCoeffDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGCoeffDiffusion.html#input-parameters", "title": "DGCoeffDiffusion"}, {"text": "JacMat", "location": "https://shannon-lab.github.io/zapdos/source/materials/JacMat.html#jacmat", "title": "JacMat"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/JacMat.html#input-parameters", "title": "JacMat"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/JacMat.html#input-files", "title": "JacMat"}, {"text": "HphiRadialInterface", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/HphiRadialInterface.html#hphiradialinterface", "title": "HphiRadialInterface"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/HphiRadialInterface.html#input-parameters", "title": "HphiRadialInterface"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/HphiRadialInterface.html#input-files", "title": "HphiRadialInterface"}, {"text": "UserFlux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/UserFlux.html#userflux", "title": "UserFlux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/UserFlux.html#input-parameters", "title": "UserFlux"}, {"text": "IonsFromIonization", "location": "https://shannon-lab.github.io/zapdos/source/kernels/IonsFromIonization.html#ionsfromionization", "title": "IonsFromIonization"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/IonsFromIonization.html#input-parameters", "title": "IonsFromIonization"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/IonsFromIonization.html#input-files", "title": "IonsFromIonization"}, {"text": "CoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusion.html#coeffdiffusion", "title": "CoeffDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusion.html#input-parameters", "title": "CoeffDiffusion"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusion.html#input-files", "title": "CoeffDiffusion"}, {"text": "Adaptivity Indicators System", "location": "https://shannon-lab.github.io/zapdos/syntax/Adaptivity/Indicators/index.html#adaptivity-indicators-system", "title": "Adaptivity Indicators System"}, {"text": "Actions System", "location": "https://shannon-lab.github.io/zapdos/syntax/Actions/index.html#actions-system", "title": "Actions System"}, {"text": "InterfaceAdvection", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceAdvection.html#interfaceadvection", "title": "InterfaceAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceAdvection.html#input-parameters", "title": "InterfaceAdvection"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceAdvection.html#input-files", "title": "InterfaceAdvection"}, {"text": "ProcRateForRateCoeffThreeBody", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeffThreeBody.html#procrateforratecoeffthreebody", "title": "ProcRateForRateCoeffThreeBody"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeffThreeBody.html#input-parameters", "title": "ProcRateForRateCoeffThreeBody"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeffThreeBody.html#input-files", "title": "ProcRateForRateCoeffThreeBody"}, {"text": "ArbitrarilyTiedValueConstraint", "location": "https://shannon-lab.github.io/zapdos/source/constraints/ArbitrarilyTiedValueConstraint.html#arbitrarilytiedvalueconstraint", "title": "ArbitrarilyTiedValueConstraint"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/constraints/ArbitrarilyTiedValueConstraint.html#input-parameters", "title": "ArbitrarilyTiedValueConstraint"}, {"text": "LotsOfSources System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfSources/index.html#lotsofsources-system", "title": "LotsOfSources System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfSources/index.html#available-objects", "title": "LotsOfSources System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfSources/index.html#available-actions", "title": "LotsOfSources System"}, {"text": "UserSource", "location": "https://shannon-lab.github.io/zapdos/source/kernels/UserSource.html#usersource", "title": "UserSource"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/UserSource.html#input-parameters", "title": "UserSource"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/UserSource.html#input-files", "title": "UserSource"}, {"text": "ProvideMobility", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/ProvideMobility.html#providemobility", "title": "ProvideMobility"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/ProvideMobility.html#input-parameters", "title": "ProvideMobility"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/ProvideMobility.html#input-files", "title": "ProvideMobility"}, {"text": "LotsOfCoeffDiffusion System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfCoeffDiffusion/index.html#lotsofcoeffdiffusion-system", "title": "LotsOfCoeffDiffusion System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfCoeffDiffusion/index.html#available-objects", "title": "LotsOfCoeffDiffusion System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfCoeffDiffusion/index.html#available-actions", "title": "LotsOfCoeffDiffusion System"}, {"text": "Water", "location": "https://shannon-lab.github.io/zapdos/source/materials/Water.html#water", "title": "Water"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/Water.html#input-parameters", "title": "Water"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/Water.html#input-files", "title": "Water"}, {"text": "DriftDiffusionUser", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionUser.html#driftdiffusionuser", "title": "DriftDiffusionUser"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionUser.html#input-parameters", "title": "DriftDiffusionUser"}, {"text": "AddLotsOfCoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfCoeffDiffusion.html#addlotsofcoeffdiffusion", "title": "AddLotsOfCoeffDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfCoeffDiffusion.html#input-parameters", "title": "AddLotsOfCoeffDiffusion"}, {"text": "ElectronEnergyTermRate", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermRate.html#electronenergytermrate", "title": "ElectronEnergyTermRate"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermRate.html#input-parameters", "title": "ElectronEnergyTermRate"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermRate.html#input-files", "title": "ElectronEnergyTermRate"}, {"text": "GasBase", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasBase.html#gasbase", "title": "GasBase"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasBase.html#input-parameters", "title": "GasBase"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasBase.html#input-files", "title": "GasBase"}, {"text": "SecondaryElectronBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SecondaryElectronBC.html#secondaryelectronbc", "title": "SecondaryElectronBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SecondaryElectronBC.html#input-parameters", "title": "SecondaryElectronBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SecondaryElectronBC.html#input-files", "title": "SecondaryElectronBC"}, {"text": "BlockAverageValue", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/BlockAverageValue.html#blockaveragevalue", "title": "BlockAverageValue"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/BlockAverageValue.html#input-parameters", "title": "BlockAverageValue"}, {"text": "LotsOfVariables System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfVariables/index.html#lotsofvariables-system", "title": "LotsOfVariables System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfVariables/index.html#available-objects", "title": "LotsOfVariables System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfVariables/index.html#available-actions", "title": "LotsOfVariables System"}, {"text": "DCIonBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DCIonBC.html#dcionbc", "title": "DCIonBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DCIonBC.html#input-parameters", "title": "DCIonBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DCIonBC.html#input-files", "title": "DCIonBC"}, {"text": "Gas", "location": "https://shannon-lab.github.io/zapdos/source/materials/Gas.html#gas", "title": "Gas"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/Gas.html#input-parameters", "title": "Gas"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/Gas.html#input-files", "title": "Gas"}, {"text": "HOME", "location": "https://shannon-lab.github.io/zapdos/index.html#home", "title": "HOME"}, {"text": "Zapdos", "location": "https://shannon-lab.github.io/zapdos/index.html#zapdos", "title": "HOME"}, {"text": "An open source MOOSE Framework application for the simulation of plasmas", "location": "https://shannon-lab.github.io/zapdos/index.html#an-open-source-moose-framework-application-for-the-simulation-of-plasmas", "title": "HOME"}, {"text": "Rapid Development", "location": "https://shannon-lab.github.io/zapdos/index.html#rapid-development", "title": "HOME"}, {"text": "User Focused", "location": "https://shannon-lab.github.io/zapdos/index.html#user-focused", "title": "HOME"}, {"text": "Getting Started", "location": "https://shannon-lab.github.io/zapdos/index.html#getting-started", "title": "HOME"}, {"text": "InterfaceKernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/InterfaceKernels/index.html#interfacekernels-system", "title": "InterfaceKernels System"}, {"text": "TM 0 AntennaVertBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0AntennaVertBC.html#tm-0-antennavertbc", "title": "TM 0 AntennaVertBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0AntennaVertBC.html#input-parameters", "title": "TM 0 AntennaVertBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0AntennaVertBC.html#input-files", "title": "TM 0 AntennaVertBC"}, {"text": "GasElectronMoments", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasElectronMoments.html#gaselectronmoments", "title": "GasElectronMoments"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasElectronMoments.html#input-parameters", "title": "GasElectronMoments"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasElectronMoments.html#input-files", "title": "GasElectronMoments"}, {"text": "Materials System", "location": "https://shannon-lab.github.io/zapdos/syntax/Materials/index.html#materials-system", "title": "Materials System"}, {"text": "ReactantFirstOrderRxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantFirstOrderRxn.html#reactantfirstorderrxn", "title": "ReactantFirstOrderRxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantFirstOrderRxn.html#input-parameters", "title": "ReactantFirstOrderRxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantFirstOrderRxn.html#input-files", "title": "ReactantFirstOrderRxn"}, {"text": "Efield", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Efield.html#efield", "title": "Efield"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Efield.html#input-parameters", "title": "Efield"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Efield.html#input-files", "title": "Efield"}, {"text": "HagelaarIonDiffusionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonDiffusionBC.html#hagelaariondiffusionbc", "title": "HagelaarIonDiffusionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonDiffusionBC.html#input-parameters", "title": "HagelaarIonDiffusionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonDiffusionBC.html#input-files", "title": "HagelaarIonDiffusionBC"}, {"text": "ElectronDiffusionDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronDiffusionDoNothingBC.html#electrondiffusiondonothingbc", "title": "ElectronDiffusionDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronDiffusionDoNothingBC.html#input-parameters", "title": "ElectronDiffusionDoNothingBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronDiffusionDoNothingBC.html#input-files", "title": "ElectronDiffusionDoNothingBC"}, {"text": "AbsValueAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/AbsValueAux.html#absvalueaux", "title": "AbsValueAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/AbsValueAux.html#input-parameters", "title": "AbsValueAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/AbsValueAux.html#input-files", "title": "AbsValueAux"}, {"text": "Boundary Conditions System", "location": "https://shannon-lab.github.io/zapdos/syntax/BCs/index.html#boundary-conditions-system", "title": "Boundary Conditions System"}, {"text": "ReactantAARxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantAARxn.html#reactantaarxn", "title": "ReactantAARxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantAARxn.html#input-parameters", "title": "ReactantAARxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantAARxn.html#input-files", "title": "ReactantAARxn"}, {"text": "ElectronAdvectionDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronAdvectionDoNothingBC.html#electronadvectiondonothingbc", "title": "ElectronAdvectionDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronAdvectionDoNothingBC.html#input-parameters", "title": "ElectronAdvectionDoNothingBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronAdvectionDoNothingBC.html#input-files", "title": "ElectronAdvectionDoNothingBC"}, {"text": "PowerDep", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/PowerDep.html#powerdep", "title": "PowerDep"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/PowerDep.html#input-parameters", "title": "PowerDep"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/PowerDep.html#input-files", "title": "PowerDep"}, {"text": "ProductFirstOrderRxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductFirstOrderRxn.html#productfirstorderrxn", "title": "ProductFirstOrderRxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductFirstOrderRxn.html#input-parameters", "title": "ProductFirstOrderRxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductFirstOrderRxn.html#input-files", "title": "ProductFirstOrderRxn"}, {"text": "InterfaceLogDiffusionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceLogDiffusionElectrons.html#interfacelogdiffusionelectrons", "title": "InterfaceLogDiffusionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceLogDiffusionElectrons.html#input-parameters", "title": "InterfaceLogDiffusionElectrons"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceLogDiffusionElectrons.html#input-files", "title": "InterfaceLogDiffusionElectrons"}, {"text": "Sigma", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Sigma.html#sigma", "title": "Sigma"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Sigma.html#input-parameters", "title": "Sigma"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Sigma.html#input-files", "title": "Sigma"}, {"text": "SchottkyEmissionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SchottkyEmissionBC.html#schottkyemissionbc", "title": "SchottkyEmissionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SchottkyEmissionBC.html#input-parameters", "title": "SchottkyEmissionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SchottkyEmissionBC.html#input-files", "title": "SchottkyEmissionBC"}, {"text": "Code Documentation", "location": "https://shannon-lab.github.io/zapdos/documentation.menu.html#code-documentation", "title": null}, {"text": "Application Development", "location": "https://shannon-lab.github.io/zapdos/documentation.menu.html#application-development", "title": null}, {"text": "EFieldAdvectionEnergy", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionEnergy.html#efieldadvectionenergy", "title": "EFieldAdvectionEnergy"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionEnergy.html#input-parameters", "title": "EFieldAdvectionEnergy"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionEnergy.html#input-files", "title": "EFieldAdvectionEnergy"}, {"text": "NeumannCircuitVoltageMoles KV", "location": "https://shannon-lab.github.io/zapdos/source/bcs/NeumannCircuitVoltageMoles_KV.html#neumanncircuitvoltagemoles-kv", "title": "NeumannCircuitVoltageMoles KV"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/NeumannCircuitVoltageMoles_KV.html#input-parameters", "title": "NeumannCircuitVoltageMoles KV"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/NeumannCircuitVoltageMoles_KV.html#input-files", "title": "NeumannCircuitVoltageMoles KV"}, {"text": "LotsOfTimeDerivatives System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfTimeDerivatives/index.html#lotsoftimederivatives-system", "title": "LotsOfTimeDerivatives System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfTimeDerivatives/index.html#available-objects", "title": "LotsOfTimeDerivatives System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfTimeDerivatives/index.html#available-actions", "title": "LotsOfTimeDerivatives System"}, {"text": "ExcitationReaction", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ExcitationReaction.html#excitationreaction", "title": "ExcitationReaction"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ExcitationReaction.html#input-parameters", "title": "ExcitationReaction"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ExcitationReaction.html#input-files", "title": "ExcitationReaction"}]; \ No newline at end of file +var index_data = [{"text": "DGEFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGEFieldAdvection.html#dgefieldadvection", "title": "DGEFieldAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGEFieldAdvection.html#input-parameters", "title": "DGEFieldAdvection"}, {"text": "EFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvection.html#efieldadvection", "title": "EFieldAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvection.html#input-parameters", "title": "EFieldAdvection"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvection.html#input-files", "title": "EFieldAdvection"}, {"text": "AddLotsOfSources", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfSources.html#addlotsofsources", "title": "AddLotsOfSources"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfSources.html#input-parameters", "title": "AddLotsOfSources"}, {"text": "UserObjects System", "location": "https://shannon-lab.github.io/zapdos/syntax/UserObjects/index.html#userobjects-system", "title": "UserObjects System"}, {"text": "HagelaarElectronAdvectionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronAdvectionBC.html#hagelaarelectronadvectionbc", "title": "HagelaarElectronAdvectionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronAdvectionBC.html#input-parameters", "title": "HagelaarElectronAdvectionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronAdvectionBC.html#input-files", "title": "HagelaarElectronAdvectionBC"}, {"text": "DriftDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusion.html#driftdiffusion", "title": "DriftDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusion.html#input-parameters", "title": "DriftDiffusion"}, {"text": "Child Objects", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusion.html#child-objects", "title": "DriftDiffusion"}, {"text": "ElectronTimeDerivative", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronTimeDerivative.html#electrontimederivative", "title": "ElectronTimeDerivative"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronTimeDerivative.html#input-parameters", "title": "ElectronTimeDerivative"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronTimeDerivative.html#input-files", "title": "ElectronTimeDerivative"}, {"text": "ElectronEnergyLossFromElastic", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromElastic.html#electronenergylossfromelastic", "title": "ElectronEnergyLossFromElastic"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromElastic.html#input-parameters", "title": "ElectronEnergyLossFromElastic"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromElastic.html#input-files", "title": "ElectronEnergyLossFromElastic"}, {"text": "ElectronEnergyTermElasticRate", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermElasticRate.html#electronenergytermelasticrate", "title": "ElectronEnergyTermElasticRate"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermElasticRate.html#input-parameters", "title": "ElectronEnergyTermElasticRate"}, {"text": "ElectronTemperature", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ElectronTemperature.html#electrontemperature", "title": "ElectronTemperature"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ElectronTemperature.html#input-parameters", "title": "ElectronTemperature"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ElectronTemperature.html#input-files", "title": "ElectronTemperature"}, {"text": "TM 0 Cylindrical", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0Cylindrical.html#tm-0-cylindrical", "title": "TM 0 Cylindrical"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0Cylindrical.html#input-parameters", "title": "TM 0 Cylindrical"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0Cylindrical.html#input-files", "title": "TM 0 Cylindrical"}, {"text": "CoeffDiffusionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionElectrons.html#coeffdiffusionelectrons", "title": "CoeffDiffusionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionElectrons.html#input-parameters", "title": "CoeffDiffusionElectrons"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionElectrons.html#input-files", "title": "CoeffDiffusionElectrons"}, {"text": "TotalFlux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TotalFlux.html#totalflux", "title": "TotalFlux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TotalFlux.html#input-parameters", "title": "TotalFlux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TotalFlux.html#input-files", "title": "TotalFlux"}, {"text": "Getting Started", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#getting-started", "title": "Getting Started"}, {"text": "Install and Test MOOSE", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#install-and-test-moose", "title": "Getting Started"}, {"text": "Build and Test Zapdos", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#build-and-test-zapdos", "title": "Getting Started"}, {"text": "Using MOOSE as a Zapdos submodule", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#using-moose-as-a-zapdos-submodule", "title": "Getting Started"}, {"text": "Using MOOSE in its own directory", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#using-moose-in-its-own-directory", "title": "Getting Started"}, {"text": "How to Proceed", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#how-to-proceed", "title": "Getting Started"}, {"text": "Troubleshooting", "location": "https://shannon-lab.github.io/zapdos/getting_started/index.html#troubleshooting", "title": "Getting Started"}, {"text": "Source Documentation", "location": "https://shannon-lab.github.io/zapdos/source/index.html#source-documentation", "title": "Source Documentation"}, {"text": "AnalyticalDiffIndicator", "location": "https://shannon-lab.github.io/zapdos/source/indicators/AnalyticalDiffIndicator.html#analyticaldiffindicator", "title": "AnalyticalDiffIndicator"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/indicators/AnalyticalDiffIndicator.html#input-parameters", "title": "AnalyticalDiffIndicator"}, {"text": "ElectronEnergyLossFromIonization", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromIonization.html#electronenergylossfromionization", "title": "ElectronEnergyLossFromIonization"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromIonization.html#input-parameters", "title": "ElectronEnergyLossFromIonization"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromIonization.html#input-files", "title": "ElectronEnergyLossFromIonization"}, {"text": "AxisymmetricCurlZ", "location": "https://shannon-lab.github.io/zapdos/source/kernels/AxisymmetricCurlZ.html#axisymmetriccurlz", "title": "AxisymmetricCurlZ"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/AxisymmetricCurlZ.html#input-parameters", "title": "AxisymmetricCurlZ"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/AxisymmetricCurlZ.html#input-files", "title": "AxisymmetricCurlZ"}, {"text": "LymberopoulosElectronBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosElectronBC.html#lymberopouloselectronbc", "title": "LymberopoulosElectronBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosElectronBC.html#input-parameters", "title": "LymberopoulosElectronBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosElectronBC.html#input-files", "title": "LymberopoulosElectronBC"}, {"text": "ElectronTemperatureDirichletBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronTemperatureDirichletBC.html#electrontemperaturedirichletbc", "title": "ElectronTemperatureDirichletBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronTemperatureDirichletBC.html#input-parameters", "title": "ElectronTemperatureDirichletBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronTemperatureDirichletBC.html#input-files", "title": "ElectronTemperatureDirichletBC"}, {"text": "AddLotsOfTimeDerivatives", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfTimeDerivatives.html#addlotsoftimederivatives", "title": "AddLotsOfTimeDerivatives"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfTimeDerivatives.html#input-parameters", "title": "AddLotsOfTimeDerivatives"}, {"text": "LymberopoulosIonBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosIonBC.html#lymberopoulosionbc", "title": "LymberopoulosIonBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosIonBC.html#input-parameters", "title": "LymberopoulosIonBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LymberopoulosIonBC.html#input-files", "title": "LymberopoulosIonBC"}, {"text": "DensityMoles", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DensityMoles.html#densitymoles", "title": "DensityMoles"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DensityMoles.html#input-parameters", "title": "DensityMoles"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DensityMoles.html#input-files", "title": "DensityMoles"}, {"text": "ProductAABBRxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductAABBRxn.html#productaabbrxn", "title": "ProductAABBRxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductAABBRxn.html#input-parameters", "title": "ProductAABBRxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductAABBRxn.html#input-files", "title": "ProductAABBRxn"}, {"text": "HeavySpecies", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpecies.html#heavyspecies", "title": "HeavySpecies"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpecies.html#input-parameters", "title": "HeavySpecies"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpecies.html#input-files", "title": "HeavySpecies"}, {"text": "EFieldMagnitudeSource", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldMagnitudeSource.html#efieldmagnitudesource", "title": "EFieldMagnitudeSource"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldMagnitudeSource.html#input-parameters", "title": "EFieldMagnitudeSource"}, {"text": "ChargeSourceMoles KV", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ChargeSourceMoles_KV.html#chargesourcemoles-kv", "title": "ChargeSourceMoles KV"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ChargeSourceMoles_KV.html#input-parameters", "title": "ChargeSourceMoles KV"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ChargeSourceMoles_KV.html#input-files", "title": "ChargeSourceMoles KV"}, {"text": "HagelaarEnergyAdvectionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyAdvectionBC.html#hagelaarenergyadvectionbc", "title": "HagelaarEnergyAdvectionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyAdvectionBC.html#input-parameters", "title": "HagelaarEnergyAdvectionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyAdvectionBC.html#input-files", "title": "HagelaarEnergyAdvectionBC"}, {"text": "DriftDiffusionUserDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionUserDoNothingBC.html#driftdiffusionuserdonothingbc", "title": "DriftDiffusionUserDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionUserDoNothingBC.html#input-parameters", "title": "DriftDiffusionUserDoNothingBC"}, {"text": "ElectronsFromIonization", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#electronsfromionization", "title": "ElectronsFromIonization"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#input-parameters", "title": "ElectronsFromIonization"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#input-files", "title": "ElectronsFromIonization"}, {"text": "Child Objects", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonization.html#child-objects", "title": "ElectronsFromIonization"}, {"text": "DriftDiffusionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionElectrons.html#driftdiffusionelectrons", "title": "DriftDiffusionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionElectrons.html#input-parameters", "title": "DriftDiffusionElectrons"}, {"text": "AddLotsOfEFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfEFieldAdvection.html#addlotsofefieldadvection", "title": "AddLotsOfEFieldAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfEFieldAdvection.html#input-parameters", "title": "AddLotsOfEFieldAdvection"}, {"text": "AddLotsOfVariables", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfVariables.html#addlotsofvariables", "title": "AddLotsOfVariables"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfVariables.html#input-parameters", "title": "AddLotsOfVariables"}, {"text": "Postprocessors System", "location": "https://shannon-lab.github.io/zapdos/syntax/Postprocessors/index.html#postprocessors-system", "title": "Postprocessors System"}, {"text": "CoeffDiffusionLin", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionLin.html#coeffdiffusionlin", "title": "CoeffDiffusionLin"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionLin.html#input-parameters", "title": "CoeffDiffusionLin"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionLin.html#input-files", "title": "CoeffDiffusionLin"}, {"text": "HagelaarEnergyBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyBC.html#hagelaarenergybc", "title": "HagelaarEnergyBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyBC.html#input-parameters", "title": "HagelaarEnergyBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarEnergyBC.html#input-files", "title": "HagelaarEnergyBC"}, {"text": "CoeffDiffusionEnergy", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionEnergy.html#coeffdiffusionenergy", "title": "CoeffDiffusionEnergy"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionEnergy.html#input-parameters", "title": "CoeffDiffusionEnergy"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusionEnergy.html#input-files", "title": "CoeffDiffusionEnergy"}, {"text": "TM 0 CylindricalEz", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEz.html#tm-0-cylindricalez", "title": "TM 0 CylindricalEz"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEz.html#input-parameters", "title": "TM 0 CylindricalEz"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEz.html#input-files", "title": "TM 0 CylindricalEz"}, {"text": "HagelaarIonAdvectionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonAdvectionBC.html#hagelaarionadvectionbc", "title": "HagelaarIonAdvectionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonAdvectionBC.html#input-parameters", "title": "HagelaarIonAdvectionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonAdvectionBC.html#input-files", "title": "HagelaarIonAdvectionBC"}, {"text": "DriftDiffusionEnergy", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionEnergy.html#driftdiffusionenergy", "title": "DriftDiffusionEnergy"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionEnergy.html#input-parameters", "title": "DriftDiffusionEnergy"}, {"text": "NodeAndSidesetBetweenSubdomains", "location": "https://shannon-lab.github.io/zapdos/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html#nodeandsidesetbetweensubdomains", "title": "NodeAndSidesetBetweenSubdomains"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html#input-parameters", "title": "NodeAndSidesetBetweenSubdomains"}, {"text": "FieldEmissionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/FieldEmissionBC.html#fieldemissionbc", "title": "FieldEmissionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/FieldEmissionBC.html#input-parameters", "title": "FieldEmissionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/FieldEmissionBC.html#input-files", "title": "FieldEmissionBC"}, {"text": "Constraints System", "location": "https://shannon-lab.github.io/zapdos/syntax/Constraints/index.html#constraints-system", "title": "Constraints System"}, {"text": "PotentialDriftOutflowBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PotentialDriftOutflowBC.html#potentialdriftoutflowbc", "title": "PotentialDriftOutflowBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PotentialDriftOutflowBC.html#input-parameters", "title": "PotentialDriftOutflowBC"}, {"text": "LogDensityDirichletBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LogDensityDirichletBC.html#logdensitydirichletbc", "title": "LogDensityDirichletBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LogDensityDirichletBC.html#input-parameters", "title": "LogDensityDirichletBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/LogDensityDirichletBC.html#input-files", "title": "LogDensityDirichletBC"}, {"text": "HagelaarElectronBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronBC.html#hagelaarelectronbc", "title": "HagelaarElectronBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronBC.html#input-parameters", "title": "HagelaarElectronBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarElectronBC.html#input-files", "title": "HagelaarElectronBC"}, {"text": "Bounds System", "location": "https://shannon-lab.github.io/zapdos/syntax/Bounds/index.html#bounds-system", "title": "Bounds System"}, {"text": "EFieldAdvectionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionElectrons.html#efieldadvectionelectrons", "title": "EFieldAdvectionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionElectrons.html#input-parameters", "title": "EFieldAdvectionElectrons"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionElectrons.html#input-files", "title": "EFieldAdvectionElectrons"}, {"text": "DiffusiveFlux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DiffusiveFlux.html#diffusiveflux", "title": "DiffusiveFlux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DiffusiveFlux.html#input-parameters", "title": "DiffusiveFlux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DiffusiveFlux.html#input-files", "title": "DiffusiveFlux"}, {"text": "Citing Zapdos and MOOSE", "location": "https://shannon-lab.github.io/zapdos/citing.html#citing-zapdos-and-moose", "title": "Citing Zapdos and MOOSE"}, {"text": "Application", "location": "https://shannon-lab.github.io/zapdos/citing.html#application", "title": "Citing Zapdos and MOOSE"}, {"text": "MOOSE Framework", "location": "https://shannon-lab.github.io/zapdos/citing.html#moose-framework", "title": "Citing Zapdos and MOOSE"}, {"text": "ProcRateForRateCoeff", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeff.html#procrateforratecoeff", "title": "ProcRateForRateCoeff"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeff.html#input-parameters", "title": "ProcRateForRateCoeff"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeff.html#input-files", "title": "ProcRateForRateCoeff"}, {"text": "AddLotsOfPotentialDrivenArtificialDiff", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html#addlotsofpotentialdrivenartificialdiff", "title": "AddLotsOfPotentialDrivenArtificialDiff"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html#input-parameters", "title": "AddLotsOfPotentialDrivenArtificialDiff"}, {"text": "Kernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/Kernels/index.html#kernels-system", "title": "Kernels System"}, {"text": "SigmaMat", "location": "https://shannon-lab.github.io/zapdos/source/materials/SigmaMat.html#sigmamat", "title": "SigmaMat"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/SigmaMat.html#input-parameters", "title": "SigmaMat"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/SigmaMat.html#input-files", "title": "SigmaMat"}, {"text": "Questions and General Information", "location": "https://shannon-lab.github.io/zapdos/help.menu.html#questions-and-general-information", "title": null}, {"text": "Developer Information from MOOSE website", "location": "https://shannon-lab.github.io/zapdos/help.menu.html#developer-information-from-moose-website", "title": null}, {"text": "PlasmaFrequencyInverse", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/PlasmaFrequencyInverse.html#plasmafrequencyinverse", "title": "PlasmaFrequencyInverse"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/PlasmaFrequencyInverse.html#input-parameters", "title": "PlasmaFrequencyInverse"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/PlasmaFrequencyInverse.html#input-files", "title": "PlasmaFrequencyInverse"}, {"text": "Adaptivity System", "location": "https://shannon-lab.github.io/zapdos/syntax/Adaptivity/index.html#adaptivity-system", "title": "Adaptivity System"}, {"text": "ElectronEnergyLossFromExcitation", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromExcitation.html#electronenergylossfromexcitation", "title": "ElectronEnergyLossFromExcitation"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromExcitation.html#input-parameters", "title": "ElectronEnergyLossFromExcitation"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyLossFromExcitation.html#input-files", "title": "ElectronEnergyLossFromExcitation"}, {"text": "DriftDiffusionFluxAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DriftDiffusionFluxAux.html#driftdiffusionfluxaux", "title": "DriftDiffusionFluxAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DriftDiffusionFluxAux.html#input-parameters", "title": "DriftDiffusionFluxAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/DriftDiffusionFluxAux.html#input-files", "title": "DriftDiffusionFluxAux"}, {"text": "LotsOfEFieldAdvection System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfEFieldAdvection/index.html#lotsofefieldadvection-system", "title": "LotsOfEFieldAdvection System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfEFieldAdvection/index.html#available-objects", "title": "LotsOfEFieldAdvection System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfEFieldAdvection/index.html#available-actions", "title": "LotsOfEFieldAdvection System"}, {"text": "AuxKernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/AuxKernels/index.html#auxkernels-system", "title": "AuxKernels System"}, {"text": "TM 0 PECVertBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0PECVertBC.html#tm-0-pecvertbc", "title": "TM 0 PECVertBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0PECVertBC.html#input-parameters", "title": "TM 0 PECVertBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0PECVertBC.html#input-files", "title": "TM 0 PECVertBC"}, {"text": "JouleHeating", "location": "https://shannon-lab.github.io/zapdos/source/kernels/JouleHeating.html#jouleheating", "title": "JouleHeating"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/JouleHeating.html#input-parameters", "title": "JouleHeating"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/JouleHeating.html#input-files", "title": "JouleHeating"}, {"text": "DriftDiffusionDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionDoNothingBC.html#driftdiffusiondonothingbc", "title": "DriftDiffusionDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionDoNothingBC.html#input-parameters", "title": "DriftDiffusionDoNothingBC"}, {"text": "Child Objects", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DriftDiffusionDoNothingBC.html#child-objects", "title": "DriftDiffusionDoNothingBC"}, {"text": "Current", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Current.html#current", "title": "Current"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Current.html#input-parameters", "title": "Current"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Current.html#input-files", "title": "Current"}, {"text": "Complete Syntax", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#complete-syntax", "title": "Complete Syntax"}, {"text": "Adaptivity", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#adaptivity", "title": "Complete Syntax"}, {"text": "Adaptivity/Indicators", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#adaptivity/indicators", "title": "Complete Syntax"}, {"text": "AuxKernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#auxkernels", "title": "Complete Syntax"}, {"text": "BCs", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#bcs", "title": "Complete Syntax"}, {"text": "Bounds", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#bounds", "title": "Complete Syntax"}, {"text": "Constraints", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#constraints", "title": "Complete Syntax"}, {"text": "DGKernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#dgkernels", "title": "Complete Syntax"}, {"text": "InterfaceKernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#interfacekernels", "title": "Complete Syntax"}, {"text": "Kernels", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#kernels", "title": "Complete Syntax"}, {"text": "LotsOfCoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofcoeffdiffusion", "title": "Complete Syntax"}, {"text": "LotsOfEFieldAdvection", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofefieldadvection", "title": "Complete Syntax"}, {"text": "LotsOfPotentialDrivenArtificialDiff", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofpotentialdrivenartificialdiff", "title": "Complete Syntax"}, {"text": "LotsOfSources", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofsources", "title": "Complete Syntax"}, {"text": "LotsOfTimeDerivatives", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsoftimederivatives", "title": "Complete Syntax"}, {"text": "LotsOfVariables", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#lotsofvariables", "title": "Complete Syntax"}, {"text": "Materials", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#materials", "title": "Complete Syntax"}, {"text": "MeshModifiers", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#meshmodifiers", "title": "Complete Syntax"}, {"text": "Postprocessors", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#postprocessors", "title": "Complete Syntax"}, {"text": "UserObjects", "location": "https://shannon-lab.github.io/zapdos/syntax/index.html#userobjects", "title": "Complete Syntax"}, {"text": "TM 0 CylindricalErAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalErAux.html#tm-0-cylindricaleraux", "title": "TM 0 CylindricalErAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalErAux.html#input-parameters", "title": "TM 0 CylindricalErAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalErAux.html#input-files", "title": "TM 0 CylindricalErAux"}, {"text": "TM 0 CylindricalEzAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalEzAux.html#tm-0-cylindricalezaux", "title": "TM 0 CylindricalEzAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalEzAux.html#input-parameters", "title": "TM 0 CylindricalEzAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/TM0CylindricalEzAux.html#input-files", "title": "TM 0 CylindricalEzAux"}, {"text": "Indicators System", "location": "https://shannon-lab.github.io/zapdos/syntax/Indicators/index.html#indicators-system", "title": "Indicators System"}, {"text": "Position", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Position.html#position", "title": "Position"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Position.html#input-parameters", "title": "Position"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Position.html#input-files", "title": "Position"}, {"text": "ProcRate", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRate.html#procrate", "title": "ProcRate"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRate.html#input-parameters", "title": "ProcRate"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRate.html#input-files", "title": "ProcRate"}, {"text": "CurrentDensityShapeSideUserObject", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/CurrentDensityShapeSideUserObject.html#currentdensityshapesideuserobject", "title": "CurrentDensityShapeSideUserObject"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/CurrentDensityShapeSideUserObject.html#input-parameters", "title": "CurrentDensityShapeSideUserObject"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/CurrentDensityShapeSideUserObject.html#input-files", "title": "CurrentDensityShapeSideUserObject"}, {"text": "LotsOfPotentialDrivenArtificialDiff System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfPotentialDrivenArtificialDiff/index.html#lotsofpotentialdrivenartificialdiff-system", "title": "LotsOfPotentialDrivenArtificialDiff System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfPotentialDrivenArtificialDiff/index.html#available-objects", "title": "LotsOfPotentialDrivenArtificialDiff System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfPotentialDrivenArtificialDiff/index.html#available-actions", "title": "LotsOfPotentialDrivenArtificialDiff System"}, {"text": "PenaltyCircuitPotential", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PenaltyCircuitPotential.html#penaltycircuitpotential", "title": "PenaltyCircuitPotential"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PenaltyCircuitPotential.html#input-parameters", "title": "PenaltyCircuitPotential"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/PenaltyCircuitPotential.html#input-files", "title": "PenaltyCircuitPotential"}, {"text": "MeshModifiers System", "location": "https://shannon-lab.github.io/zapdos/syntax/MeshModifiers/index.html#meshmodifiers-system", "title": "MeshModifiers System"}, {"text": "CircuitDirichletPotential", "location": "https://shannon-lab.github.io/zapdos/source/bcs/CircuitDirichletPotential.html#circuitdirichletpotential", "title": "CircuitDirichletPotential"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/CircuitDirichletPotential.html#input-parameters", "title": "CircuitDirichletPotential"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/CircuitDirichletPotential.html#input-files", "title": "CircuitDirichletPotential"}, {"text": "TM 0 CylindricalEr", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEr.html#tm-0-cylindricaler", "title": "TM 0 CylindricalEr"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEr.html#input-parameters", "title": "TM 0 CylindricalEr"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/TM0CylindricalEr.html#input-files", "title": "TM 0 CylindricalEr"}, {"text": "PotentialGradientSource", "location": "https://shannon-lab.github.io/zapdos/source/kernels/PotentialGradientSource.html#potentialgradientsource", "title": "PotentialGradientSource"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/PotentialGradientSource.html#input-parameters", "title": "PotentialGradientSource"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/PotentialGradientSource.html#input-files", "title": "PotentialGradientSource"}, {"text": "HeavySpeciesMaterial", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpeciesMaterial.html#heavyspeciesmaterial", "title": "HeavySpeciesMaterial"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpeciesMaterial.html#input-parameters", "title": "HeavySpeciesMaterial"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/HeavySpeciesMaterial.html#input-files", "title": "HeavySpeciesMaterial"}, {"text": "LogStabilizationMoles", "location": "https://shannon-lab.github.io/zapdos/source/kernels/LogStabilizationMoles.html#logstabilizationmoles", "title": "LogStabilizationMoles"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/LogStabilizationMoles.html#input-parameters", "title": "LogStabilizationMoles"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/LogStabilizationMoles.html#input-files", "title": "LogStabilizationMoles"}, {"text": "EFieldAdvAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/EFieldAdvAux.html#efieldadvaux", "title": "EFieldAdvAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/EFieldAdvAux.html#input-parameters", "title": "EFieldAdvAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/EFieldAdvAux.html#input-files", "title": "EFieldAdvAux"}, {"text": "EFieldArtDiff", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldArtDiff.html#efieldartdiff", "title": "EFieldArtDiff"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldArtDiff.html#input-parameters", "title": "EFieldArtDiff"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldArtDiff.html#input-files", "title": "EFieldArtDiff"}, {"text": "SideTotFluxIntegral", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/SideTotFluxIntegral.html#sidetotfluxintegral", "title": "SideTotFluxIntegral"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/SideTotFluxIntegral.html#input-parameters", "title": "SideTotFluxIntegral"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/postprocessors/SideTotFluxIntegral.html#input-files", "title": "SideTotFluxIntegral"}, {"text": "DGKernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/DGKernels/index.html#dgkernels-system", "title": "DGKernels System"}, {"text": "ElectronsFromIonizationUser", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonizationUser.html#electronsfromionizationuser", "title": "ElectronsFromIonizationUser"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronsFromIonizationUser.html#input-parameters", "title": "ElectronsFromIonizationUser"}, {"text": "DGCoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGCoeffDiffusion.html#dgcoeffdiffusion", "title": "DGCoeffDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/dgkernels/DGCoeffDiffusion.html#input-parameters", "title": "DGCoeffDiffusion"}, {"text": "JacMat", "location": "https://shannon-lab.github.io/zapdos/source/materials/JacMat.html#jacmat", "title": "JacMat"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/JacMat.html#input-parameters", "title": "JacMat"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/JacMat.html#input-files", "title": "JacMat"}, {"text": "HphiRadialInterface", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/HphiRadialInterface.html#hphiradialinterface", "title": "HphiRadialInterface"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/HphiRadialInterface.html#input-parameters", "title": "HphiRadialInterface"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/HphiRadialInterface.html#input-files", "title": "HphiRadialInterface"}, {"text": "UserFlux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/UserFlux.html#userflux", "title": "UserFlux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/UserFlux.html#input-parameters", "title": "UserFlux"}, {"text": "IonsFromIonization", "location": "https://shannon-lab.github.io/zapdos/source/kernels/IonsFromIonization.html#ionsfromionization", "title": "IonsFromIonization"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/IonsFromIonization.html#input-parameters", "title": "IonsFromIonization"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/IonsFromIonization.html#input-files", "title": "IonsFromIonization"}, {"text": "CoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusion.html#coeffdiffusion", "title": "CoeffDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusion.html#input-parameters", "title": "CoeffDiffusion"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/CoeffDiffusion.html#input-files", "title": "CoeffDiffusion"}, {"text": "Adaptivity Indicators System", "location": "https://shannon-lab.github.io/zapdos/syntax/Adaptivity/Indicators/index.html#adaptivity-indicators-system", "title": "Adaptivity Indicators System"}, {"text": "Actions System", "location": "https://shannon-lab.github.io/zapdos/syntax/Actions/index.html#actions-system", "title": "Actions System"}, {"text": "InterfaceAdvection", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceAdvection.html#interfaceadvection", "title": "InterfaceAdvection"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceAdvection.html#input-parameters", "title": "InterfaceAdvection"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceAdvection.html#input-files", "title": "InterfaceAdvection"}, {"text": "ProcRateForRateCoeffThreeBody", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeffThreeBody.html#procrateforratecoeffthreebody", "title": "ProcRateForRateCoeffThreeBody"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeffThreeBody.html#input-parameters", "title": "ProcRateForRateCoeffThreeBody"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/ProcRateForRateCoeffThreeBody.html#input-files", "title": "ProcRateForRateCoeffThreeBody"}, {"text": "ArbitrarilyTiedValueConstraint", "location": "https://shannon-lab.github.io/zapdos/source/constraints/ArbitrarilyTiedValueConstraint.html#arbitrarilytiedvalueconstraint", "title": "ArbitrarilyTiedValueConstraint"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/constraints/ArbitrarilyTiedValueConstraint.html#input-parameters", "title": "ArbitrarilyTiedValueConstraint"}, {"text": "LotsOfSources System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfSources/index.html#lotsofsources-system", "title": "LotsOfSources System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfSources/index.html#available-objects", "title": "LotsOfSources System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfSources/index.html#available-actions", "title": "LotsOfSources System"}, {"text": "UserSource", "location": "https://shannon-lab.github.io/zapdos/source/kernels/UserSource.html#usersource", "title": "UserSource"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/UserSource.html#input-parameters", "title": "UserSource"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/UserSource.html#input-files", "title": "UserSource"}, {"text": "ProvideMobility", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/ProvideMobility.html#providemobility", "title": "ProvideMobility"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/ProvideMobility.html#input-parameters", "title": "ProvideMobility"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/ProvideMobility.html#input-files", "title": "ProvideMobility"}, {"text": "LotsOfCoeffDiffusion System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfCoeffDiffusion/index.html#lotsofcoeffdiffusion-system", "title": "LotsOfCoeffDiffusion System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfCoeffDiffusion/index.html#available-objects", "title": "LotsOfCoeffDiffusion System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfCoeffDiffusion/index.html#available-actions", "title": "LotsOfCoeffDiffusion System"}, {"text": "Water", "location": "https://shannon-lab.github.io/zapdos/source/materials/Water.html#water", "title": "Water"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/Water.html#input-parameters", "title": "Water"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/Water.html#input-files", "title": "Water"}, {"text": "DriftDiffusionUser", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionUser.html#driftdiffusionuser", "title": "DriftDiffusionUser"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/DriftDiffusionUser.html#input-parameters", "title": "DriftDiffusionUser"}, {"text": "AddLotsOfCoeffDiffusion", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfCoeffDiffusion.html#addlotsofcoeffdiffusion", "title": "AddLotsOfCoeffDiffusion"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/actions/AddLotsOfCoeffDiffusion.html#input-parameters", "title": "AddLotsOfCoeffDiffusion"}, {"text": "ElectronEnergyTermRate", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermRate.html#electronenergytermrate", "title": "ElectronEnergyTermRate"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermRate.html#input-parameters", "title": "ElectronEnergyTermRate"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ElectronEnergyTermRate.html#input-files", "title": "ElectronEnergyTermRate"}, {"text": "GasBase", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasBase.html#gasbase", "title": "GasBase"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasBase.html#input-parameters", "title": "GasBase"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasBase.html#input-files", "title": "GasBase"}, {"text": "SecondaryElectronBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SecondaryElectronBC.html#secondaryelectronbc", "title": "SecondaryElectronBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SecondaryElectronBC.html#input-parameters", "title": "SecondaryElectronBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SecondaryElectronBC.html#input-files", "title": "SecondaryElectronBC"}, {"text": "BlockAverageValue", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/BlockAverageValue.html#blockaveragevalue", "title": "BlockAverageValue"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/userobjects/BlockAverageValue.html#input-parameters", "title": "BlockAverageValue"}, {"text": "LotsOfVariables System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfVariables/index.html#lotsofvariables-system", "title": "LotsOfVariables System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfVariables/index.html#available-objects", "title": "LotsOfVariables System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfVariables/index.html#available-actions", "title": "LotsOfVariables System"}, {"text": "DCIonBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DCIonBC.html#dcionbc", "title": "DCIonBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DCIonBC.html#input-parameters", "title": "DCIonBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/DCIonBC.html#input-files", "title": "DCIonBC"}, {"text": "Gas", "location": "https://shannon-lab.github.io/zapdos/source/materials/Gas.html#gas", "title": "Gas"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/Gas.html#input-parameters", "title": "Gas"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/Gas.html#input-files", "title": "Gas"}, {"text": "HOME", "location": "https://shannon-lab.github.io/zapdos/index.html#home", "title": "HOME"}, {"text": "Zapdos", "location": "https://shannon-lab.github.io/zapdos/index.html#zapdos", "title": "HOME"}, {"text": "An open source MOOSE Framework application for the simulation of plasmas", "location": "https://shannon-lab.github.io/zapdos/index.html#an-open-source-moose-framework-application-for-the-simulation-of-plasmas", "title": "HOME"}, {"text": "Rapid Development", "location": "https://shannon-lab.github.io/zapdos/index.html#rapid-development", "title": "HOME"}, {"text": "User Focused", "location": "https://shannon-lab.github.io/zapdos/index.html#user-focused", "title": "HOME"}, {"text": "Getting Started", "location": "https://shannon-lab.github.io/zapdos/index.html#getting-started", "title": "HOME"}, {"text": "Collaborators", "location": "https://shannon-lab.github.io/zapdos/index.html#collaborators", "title": "HOME"}, {"text": "Funding Acknowledgements", "location": "https://shannon-lab.github.io/zapdos/index.html#funding-acknowledgements", "title": "HOME"}, {"text": "InterfaceKernels System", "location": "https://shannon-lab.github.io/zapdos/syntax/InterfaceKernels/index.html#interfacekernels-system", "title": "InterfaceKernels System"}, {"text": "TM 0 AntennaVertBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0AntennaVertBC.html#tm-0-antennavertbc", "title": "TM 0 AntennaVertBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0AntennaVertBC.html#input-parameters", "title": "TM 0 AntennaVertBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/TM0AntennaVertBC.html#input-files", "title": "TM 0 AntennaVertBC"}, {"text": "GasElectronMoments", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasElectronMoments.html#gaselectronmoments", "title": "GasElectronMoments"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasElectronMoments.html#input-parameters", "title": "GasElectronMoments"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/materials/GasElectronMoments.html#input-files", "title": "GasElectronMoments"}, {"text": "Materials System", "location": "https://shannon-lab.github.io/zapdos/syntax/Materials/index.html#materials-system", "title": "Materials System"}, {"text": "ReactantFirstOrderRxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantFirstOrderRxn.html#reactantfirstorderrxn", "title": "ReactantFirstOrderRxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantFirstOrderRxn.html#input-parameters", "title": "ReactantFirstOrderRxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantFirstOrderRxn.html#input-files", "title": "ReactantFirstOrderRxn"}, {"text": "Efield", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Efield.html#efield", "title": "Efield"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Efield.html#input-parameters", "title": "Efield"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Efield.html#input-files", "title": "Efield"}, {"text": "HagelaarIonDiffusionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonDiffusionBC.html#hagelaariondiffusionbc", "title": "HagelaarIonDiffusionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonDiffusionBC.html#input-parameters", "title": "HagelaarIonDiffusionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/HagelaarIonDiffusionBC.html#input-files", "title": "HagelaarIonDiffusionBC"}, {"text": "ElectronDiffusionDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronDiffusionDoNothingBC.html#electrondiffusiondonothingbc", "title": "ElectronDiffusionDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronDiffusionDoNothingBC.html#input-parameters", "title": "ElectronDiffusionDoNothingBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronDiffusionDoNothingBC.html#input-files", "title": "ElectronDiffusionDoNothingBC"}, {"text": "AbsValueAux", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/AbsValueAux.html#absvalueaux", "title": "AbsValueAux"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/AbsValueAux.html#input-parameters", "title": "AbsValueAux"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/AbsValueAux.html#input-files", "title": "AbsValueAux"}, {"text": "Boundary Conditions System", "location": "https://shannon-lab.github.io/zapdos/syntax/BCs/index.html#boundary-conditions-system", "title": "Boundary Conditions System"}, {"text": "ReactantAARxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantAARxn.html#reactantaarxn", "title": "ReactantAARxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantAARxn.html#input-parameters", "title": "ReactantAARxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ReactantAARxn.html#input-files", "title": "ReactantAARxn"}, {"text": "ElectronAdvectionDoNothingBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronAdvectionDoNothingBC.html#electronadvectiondonothingbc", "title": "ElectronAdvectionDoNothingBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronAdvectionDoNothingBC.html#input-parameters", "title": "ElectronAdvectionDoNothingBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/ElectronAdvectionDoNothingBC.html#input-files", "title": "ElectronAdvectionDoNothingBC"}, {"text": "PowerDep", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/PowerDep.html#powerdep", "title": "PowerDep"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/PowerDep.html#input-parameters", "title": "PowerDep"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/PowerDep.html#input-files", "title": "PowerDep"}, {"text": "ProductFirstOrderRxn", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductFirstOrderRxn.html#productfirstorderrxn", "title": "ProductFirstOrderRxn"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductFirstOrderRxn.html#input-parameters", "title": "ProductFirstOrderRxn"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ProductFirstOrderRxn.html#input-files", "title": "ProductFirstOrderRxn"}, {"text": "InterfaceLogDiffusionElectrons", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceLogDiffusionElectrons.html#interfacelogdiffusionelectrons", "title": "InterfaceLogDiffusionElectrons"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceLogDiffusionElectrons.html#input-parameters", "title": "InterfaceLogDiffusionElectrons"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/interfacekernels/InterfaceLogDiffusionElectrons.html#input-files", "title": "InterfaceLogDiffusionElectrons"}, {"text": "Sigma", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Sigma.html#sigma", "title": "Sigma"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Sigma.html#input-parameters", "title": "Sigma"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/auxkernels/Sigma.html#input-files", "title": "Sigma"}, {"text": "SchottkyEmissionBC", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SchottkyEmissionBC.html#schottkyemissionbc", "title": "SchottkyEmissionBC"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SchottkyEmissionBC.html#input-parameters", "title": "SchottkyEmissionBC"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/SchottkyEmissionBC.html#input-files", "title": "SchottkyEmissionBC"}, {"text": "Code Documentation", "location": "https://shannon-lab.github.io/zapdos/documentation.menu.html#code-documentation", "title": null}, {"text": "Application Development", "location": "https://shannon-lab.github.io/zapdos/documentation.menu.html#application-development", "title": null}, {"text": "EFieldAdvectionEnergy", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionEnergy.html#efieldadvectionenergy", "title": "EFieldAdvectionEnergy"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionEnergy.html#input-parameters", "title": "EFieldAdvectionEnergy"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/EFieldAdvectionEnergy.html#input-files", "title": "EFieldAdvectionEnergy"}, {"text": "NeumannCircuitVoltageMoles KV", "location": "https://shannon-lab.github.io/zapdos/source/bcs/NeumannCircuitVoltageMoles_KV.html#neumanncircuitvoltagemoles-kv", "title": "NeumannCircuitVoltageMoles KV"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/bcs/NeumannCircuitVoltageMoles_KV.html#input-parameters", "title": "NeumannCircuitVoltageMoles KV"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/bcs/NeumannCircuitVoltageMoles_KV.html#input-files", "title": "NeumannCircuitVoltageMoles KV"}, {"text": "LotsOfTimeDerivatives System", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfTimeDerivatives/index.html#lotsoftimederivatives-system", "title": "LotsOfTimeDerivatives System"}, {"text": "Available Objects", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfTimeDerivatives/index.html#available-objects", "title": "LotsOfTimeDerivatives System"}, {"text": "Available Actions", "location": "https://shannon-lab.github.io/zapdos/syntax/LotsOfTimeDerivatives/index.html#available-actions", "title": "LotsOfTimeDerivatives System"}, {"text": "ExcitationReaction", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ExcitationReaction.html#excitationreaction", "title": "ExcitationReaction"}, {"text": "Input Parameters", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ExcitationReaction.html#input-parameters", "title": "ExcitationReaction"}, {"text": "Input Files", "location": "https://shannon-lab.github.io/zapdos/source/kernels/ExcitationReaction.html#input-files", "title": "ExcitationReaction"}]; \ No newline at end of file diff --git a/media/berkeley.png b/media/berkeley.png new file mode 100644 index 00000000000..82cd07333eb Binary files /dev/null and b/media/berkeley.png differ diff --git a/media/doe.png b/media/doe.png new file mode 100644 index 00000000000..707addd5719 Binary files /dev/null and b/media/doe.png differ diff --git a/media/illinois.png b/media/illinois.png new file mode 100644 index 00000000000..a77ad32767d Binary files /dev/null and b/media/illinois.png differ diff --git a/media/inl.png b/media/inl.png new file mode 100644 index 00000000000..b489f229cea Binary files /dev/null and b/media/inl.png differ diff --git a/media/notre_dame.jpg b/media/notre_dame.jpg new file mode 100644 index 00000000000..5c116fdfdcf Binary files /dev/null and b/media/notre_dame.jpg differ diff --git a/media/nsf.png b/media/nsf.png new file mode 100644 index 00000000000..7c52c695b77 Binary files /dev/null and b/media/nsf.png differ diff --git a/media/ornl.png b/media/ornl.png new file mode 100644 index 00000000000..d3bf51f503f Binary files /dev/null and b/media/ornl.png differ diff --git a/source/actions/AddLotsOfCoeffDiffusion.html b/source/actions/AddLotsOfCoeffDiffusion.html index 3b134e7b30a..3f2180bbda3 100644 --- a/source/actions/AddLotsOfCoeffDiffusion.html +++ b/source/actions/AddLotsOfCoeffDiffusion.html @@ -1,4 +1,4 @@ -AddLotsOfCoeffDiffusion|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          AddLotsOfCoeffDiffusion

                                                          under construction:Undocumented Action Class

                                                          The AddLotsOfCoeffDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+AddLotsOfCoeffDiffusion|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          AddLotsOfCoeffDiffusion
                                                          under construction:Undocumented Action Class
                                                          The AddLotsOfCoeffDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # AddLotsOfCoeffDiffusion
 
 !syntax description /LotsOfCoeffDiffusion/AddLotsOfCoeffDiffusion
@@ -14,4 +14,4 @@
 !syntax parameters /LotsOfCoeffDiffusion/AddLotsOfCoeffDiffusion
 
                                                          
 
-!syntax description /LotsOfCoeffDiffusion/AddLotsOfCoeffDiffusion
                                                          Input Parameters
                                                          • variablesThe names of the variables for which CoeffDiffusion kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which CoeffDiffusion kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          
\ No newline at end of file
+!syntax description /LotsOfCoeffDiffusion/AddLotsOfCoeffDiffusion
                                                          Input Parameters
                                                          • variablesThe names of the variables for which CoeffDiffusion kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which CoeffDiffusion kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          \ No newline at end of file diff --git a/source/actions/AddLotsOfEFieldAdvection.html b/source/actions/AddLotsOfEFieldAdvection.html index af5e483ec2a..c5f15098423 100644 --- a/source/actions/AddLotsOfEFieldAdvection.html +++ b/source/actions/AddLotsOfEFieldAdvection.html @@ -1,4 +1,4 @@ -AddLotsOfEFieldAdvection|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          AddLotsOfEFieldAdvection

                                                          under construction:Undocumented Action Class

                                                          The AddLotsOfEFieldAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+AddLotsOfEFieldAdvection|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          AddLotsOfEFieldAdvection
                                                          under construction:Undocumented Action Class
                                                          The AddLotsOfEFieldAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # AddLotsOfEFieldAdvection
 
 !syntax description /LotsOfEFieldAdvection/AddLotsOfEFieldAdvection
@@ -14,4 +14,4 @@
 !syntax parameters /LotsOfEFieldAdvection/AddLotsOfEFieldAdvection
 
                                                          
 
-!syntax description /LotsOfEFieldAdvection/AddLotsOfEFieldAdvection
                                                          Input Parameters
                                                          • variablesThe names of the variables for which EFieldAdvection kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which EFieldAdvection kernels should be added
                                                          • potentialA dummy vector that holds the potential to couple in for advection
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:A dummy vector that holds the potential to couple in for advection
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          
\ No newline at end of file
+!syntax description /LotsOfEFieldAdvection/AddLotsOfEFieldAdvection
                                                          Input Parameters
                                                          • variablesThe names of the variables for which EFieldAdvection kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which EFieldAdvection kernels should be added
                                                          • potentialA dummy vector that holds the potential to couple in for advection
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:A dummy vector that holds the potential to couple in for advection
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          \ No newline at end of file diff --git a/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html b/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html index 20ec4b83f59..a09e574b628 100644 --- a/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html +++ b/source/actions/AddLotsOfPotentialDrivenArtificialDiff.html @@ -1,4 +1,4 @@ -AddLotsOfPotentialDrivenArtificialDiff|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          AddLotsOfPotentialDrivenArtificialDiff

                                                          under construction:Undocumented Action Class

                                                          The AddLotsOfPotentialDrivenArtificialDiff has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+AddLotsOfPotentialDrivenArtificialDiff|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          AddLotsOfPotentialDrivenArtificialDiff
                                                          under construction:Undocumented Action Class
                                                          The AddLotsOfPotentialDrivenArtificialDiff has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # AddLotsOfPotentialDrivenArtificialDiff
 
 !syntax description /LotsOfPotentialDrivenArtificialDiff/AddLotsOfPotentialDrivenArtificialDiff
@@ -14,4 +14,4 @@
 !syntax parameters /LotsOfPotentialDrivenArtificialDiff/AddLotsOfPotentialDrivenArtificialDiff
 
                                                          
 
-!syntax description /LotsOfPotentialDrivenArtificialDiff/AddLotsOfPotentialDrivenArtificialDiff
                                                          Input Parameters
                                                          • variablesThe names of the variables for which PotentialDrivenArtificialDiff kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which PotentialDrivenArtificialDiff kernels should be added
                                                          • potentialA dummy vector that holds the potential to couple in for advection
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:A dummy vector that holds the potential to couple in for advection
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • delta0.5Used for determining the amount of artificial diffusion to add.
                                                            Default:0.5
                                                            C++ Type:double
                                                            Options:
                                                            Description:Used for determining the amount of artificial diffusion to add.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          
\ No newline at end of file
+!syntax description /LotsOfPotentialDrivenArtificialDiff/AddLotsOfPotentialDrivenArtificialDiff
                                                          Input Parameters
                                                          • variablesThe names of the variables for which PotentialDrivenArtificialDiff kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which PotentialDrivenArtificialDiff kernels should be added
                                                          • potentialA dummy vector that holds the potential to couple in for advection
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:A dummy vector that holds the potential to couple in for advection
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • delta0.5Used for determining the amount of artificial diffusion to add.
                                                            Default:0.5
                                                            C++ Type:double
                                                            Options:
                                                            Description:Used for determining the amount of artificial diffusion to add.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          \ No newline at end of file diff --git a/source/actions/AddLotsOfSources.html b/source/actions/AddLotsOfSources.html index efb8b2e5aa6..fa8907f4402 100644 --- a/source/actions/AddLotsOfSources.html +++ b/source/actions/AddLotsOfSources.html @@ -1,4 +1,4 @@ -AddLotsOfSources|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          AddLotsOfSources

                                                          under construction:Undocumented Action Class

                                                          The AddLotsOfSources has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+AddLotsOfSources|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          AddLotsOfSources
                                                          under construction:Undocumented Action Class
                                                          The AddLotsOfSources has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # AddLotsOfSources
 
 !syntax description /LotsOfSources/AddLotsOfSources
@@ -14,4 +14,4 @@
 !syntax parameters /LotsOfSources/AddLotsOfSources
 
                                                          
 
-!syntax description /LotsOfSources/AddLotsOfSources
                                                          Input Parameters
                                                          • variablesThe names of the variables for which Source kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which Source kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          
\ No newline at end of file
+!syntax description /LotsOfSources/AddLotsOfSources
                                                          Input Parameters
                                                          • variablesThe names of the variables for which Source kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which Source kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          \ No newline at end of file diff --git a/source/actions/AddLotsOfTimeDerivatives.html b/source/actions/AddLotsOfTimeDerivatives.html index 5aeb55f1c5d..50a2bc01894 100644 --- a/source/actions/AddLotsOfTimeDerivatives.html +++ b/source/actions/AddLotsOfTimeDerivatives.html @@ -1,4 +1,4 @@ -AddLotsOfTimeDerivatives|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          AddLotsOfTimeDerivatives

                                                          under construction:Undocumented Action Class

                                                          The AddLotsOfTimeDerivatives has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+AddLotsOfTimeDerivatives|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          AddLotsOfTimeDerivatives
                                                          under construction:Undocumented Action Class
                                                          The AddLotsOfTimeDerivatives has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # AddLotsOfTimeDerivatives
 
 !syntax description /LotsOfTimeDerivatives/AddLotsOfTimeDerivatives
@@ -14,4 +14,4 @@
 !syntax parameters /LotsOfTimeDerivatives/AddLotsOfTimeDerivatives
 
                                                          
 
-!syntax description /LotsOfTimeDerivatives/AddLotsOfTimeDerivatives
                                                          Input Parameters
                                                          • variablesThe names of the variables for which TimeDerivative kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which TimeDerivative kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          
\ No newline at end of file
+!syntax description /LotsOfTimeDerivatives/AddLotsOfTimeDerivatives
                                                          Input Parameters
                                                          • variablesThe names of the variables for which TimeDerivative kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which TimeDerivative kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          \ No newline at end of file diff --git a/source/actions/AddLotsOfVariables.html b/source/actions/AddLotsOfVariables.html index 40fddcf88de..d035835dfa6 100644 --- a/source/actions/AddLotsOfVariables.html +++ b/source/actions/AddLotsOfVariables.html @@ -1,4 +1,4 @@ -AddLotsOfVariables|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          AddLotsOfVariables

                                                          under construction:Undocumented Action Class

                                                          The AddLotsOfVariables has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+AddLotsOfVariables|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          AddLotsOfVariables
                                                          under construction:Undocumented Action Class
                                                          The AddLotsOfVariables has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # AddLotsOfVariables
 
 !syntax description /LotsOfVariables/AddLotsOfVariables
@@ -14,4 +14,4 @@
 !syntax parameters /LotsOfVariables/AddLotsOfVariables
 
                                                          
 
-!syntax description /LotsOfVariables/AddLotsOfVariables
                                                          Input Parameters
                                                          • variablesThe names of the variables for which CoeffDiffusion kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which CoeffDiffusion kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          
\ No newline at end of file
+!syntax description /LotsOfVariables/AddLotsOfVariables
                                                          Input Parameters
                                                          • variablesThe names of the variables for which CoeffDiffusion kernels should be added
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The names of the variables for which CoeffDiffusion kernels should be added
                                                          Required Parameters
                                                          • familyLAGRANGESpecifies the family of FE shape functions to use for this variable
                                                            Default:LAGRANGE
                                                            C++ Type:MooseEnum
                                                            Options:LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC NEDELEC_ONE LAGRANGE_VEC
                                                            Description:Specifies the family of FE shape functions to use for this variable
                                                          • scalingSpecifies a scaling factor to apply to this variable
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Specifies a scaling factor to apply to this variable
                                                          • inactiveIf specified blocks matching these identifiers will be skipped.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified blocks matching these identifiers will be skipped.
                                                          • active__all__ If specified only the blocks named will be visited and made active
                                                            Default:__all__ 
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:If specified only the blocks named will be visited and made active
                                                          • isObjectActionTrueIndicates that this is a MooseObjectAction.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Indicates that this is a MooseObjectAction.
                                                          • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:CONSTANT FIRST SECOND THIRD FOURTH
                                                            Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
                                                          Optional Parameters
                                                          \ No newline at end of file diff --git a/source/auxkernels/AbsValueAux.html b/source/auxkernels/AbsValueAux.html index 7dd39e521a5..b9b5d75c216 100644 --- a/source/auxkernels/AbsValueAux.html +++ b/source/auxkernels/AbsValueAux.html @@ -1,4 +1,4 @@ -AbsValueAux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          AbsValueAux

                                                          under construction:Undocumented Class

                                                          The AbsValueAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+AbsValueAux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          AbsValueAux
                                                          under construction:Undocumented Class
                                                          The AbsValueAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # AbsValueAux
 
 !syntax description /AuxKernels/AbsValueAux
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/AbsValueAux
 
                                                          
 
-!syntax description /AuxKernels/AbsValueAux
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • uVariable we want absolute value of.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Variable we want absolute value of.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/Current.html b/source/auxkernels/Current.html index d7e8bf658f7..cea6f637003 100644 --- a/source/auxkernels/Current.html +++ b/source/auxkernels/Current.html @@ -1,4 +1,4 @@ -Current|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          Current

                                                          under construction:Undocumented Class

                                                          The Current has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+Current|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          Current
                                                          under construction:Undocumented Class
                                                          The Current has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # Current
 
 !syntax description /AuxKernels/Current
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/Current
 
                                                          
 
-!syntax description /AuxKernels/Current
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe electron density
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density
                                                          • potentialThe potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • art_diffFalseWhether there is a current contribution from artificial diffusion.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether there is a current contribution from artificial diffusion.
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/DensityMoles.html b/source/auxkernels/DensityMoles.html index a6585ff9186..7f2488e27cf 100644 --- a/source/auxkernels/DensityMoles.html +++ b/source/auxkernels/DensityMoles.html @@ -1,4 +1,4 @@ -DensityMoles|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DensityMoles

                                                          under construction:Undocumented Class

                                                          The DensityMoles has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DensityMoles|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DensityMoles
                                                          under construction:Undocumented Class
                                                          The DensityMoles has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DensityMoles
 
 !syntax description /AuxKernels/DensityMoles
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/DensityMoles
 
                                                          
 
-!syntax description /AuxKernels/DensityMoles
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe variable representing the log of the density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The variable representing the log of the density.
                                                          • use_molesFalseWhether to convert from units of moles to #.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether to convert from units of moles to #.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/DiffusiveFlux.html b/source/auxkernels/DiffusiveFlux.html index b75ba31911e..55416df1fe1 100644 --- a/source/auxkernels/DiffusiveFlux.html +++ b/source/auxkernels/DiffusiveFlux.html @@ -1,4 +1,4 @@ -DiffusiveFlux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DiffusiveFlux

                                                          under construction:Undocumented Class

                                                          The DiffusiveFlux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DiffusiveFlux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DiffusiveFlux
                                                          under construction:Undocumented Class
                                                          The DiffusiveFlux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DiffusiveFlux
 
 !syntax description /AuxKernels/DiffusiveFlux
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/DiffusiveFlux
 
                                                          
 
-!syntax description /AuxKernels/DiffusiveFlux
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe variable representing the log of the density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The variable representing the log of the density.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/DriftDiffusionFluxAux.html b/source/auxkernels/DriftDiffusionFluxAux.html index 750a92597f2..4aae7d73417 100644 --- a/source/auxkernels/DriftDiffusionFluxAux.html +++ b/source/auxkernels/DriftDiffusionFluxAux.html @@ -1,4 +1,4 @@ -DriftDiffusionFluxAux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DriftDiffusionFluxAux

                                                          under construction:Undocumented Class

                                                          The DriftDiffusionFluxAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DriftDiffusionFluxAux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DriftDiffusionFluxAux
                                                          under construction:Undocumented Class
                                                          The DriftDiffusionFluxAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DriftDiffusionFluxAux
 
 !syntax description /AuxKernels/DriftDiffusionFluxAux
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/DriftDiffusionFluxAux
 
                                                          
 
-!syntax description /AuxKernels/DriftDiffusionFluxAux
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • potentialThe potential responsible for charge advection
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential responsible for charge advection
                                                          • uThe drift-diffusing species.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The drift-diffusing species.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • component0The flux component you want to see.
                                                            Default:0
                                                            C++ Type:int
                                                            Options:
                                                            Description:The flux component you want to see.
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • positive_chargeTrueWhether the potential is advecting positive charges. Should be set to false if charges are negative.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether the potential is advecting positive charges. Should be set to false if charges are negative.
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/EFieldAdvAux.html b/source/auxkernels/EFieldAdvAux.html index 3c15d217de5..041ea8216cb 100644 --- a/source/auxkernels/EFieldAdvAux.html +++ b/source/auxkernels/EFieldAdvAux.html @@ -1,4 +1,4 @@ -EFieldAdvAux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          EFieldAdvAux

                                                          under construction:Undocumented Class

                                                          The EFieldAdvAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+EFieldAdvAux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          EFieldAdvAux
                                                          under construction:Undocumented Class
                                                          The EFieldAdvAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # EFieldAdvAux
 
 !syntax description /AuxKernels/EFieldAdvAux
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/EFieldAdvAux
 
                                                          
 
-!syntax description /AuxKernels/EFieldAdvAux
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe variable representing the log of the density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The variable representing the log of the density.
                                                          • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The gradient of the potential will be used to compute the advection velocity.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/Efield.html b/source/auxkernels/Efield.html index 0e57291bfef..9b53c061253 100644 --- a/source/auxkernels/Efield.html +++ b/source/auxkernels/Efield.html @@ -1,4 +1,4 @@ -Efield|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          Efield

                                                          under construction:Undocumented Class

                                                          The Efield has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+Efield|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          Efield
                                                          under construction:Undocumented Class
                                                          The Efield has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # Efield
 
 !syntax description /AuxKernels/Efield
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/Efield
 
                                                          
 
-!syntax description /AuxKernels/Efield
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • potentialThe potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential
                                                          • componentThe component of the electric field to access. Accepts an integer
                                                            C++ Type:int
                                                            Options:
                                                            Description:The component of the electric field to access. Accepts an integer
                                                          • potential_unitsThe potential units.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The potential units.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/ElectronTemperature.html b/source/auxkernels/ElectronTemperature.html index c02e544545d..e0bf546e21e 100644 --- a/source/auxkernels/ElectronTemperature.html +++ b/source/auxkernels/ElectronTemperature.html @@ -1,4 +1,4 @@ -ElectronTemperature|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ElectronTemperature

                                                          under construction:Undocumented Class

                                                          The ElectronTemperature has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ElectronTemperature|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ElectronTemperature
                                                          under construction:Undocumented Class
                                                          The ElectronTemperature has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ElectronTemperature
 
 !syntax description /AuxKernels/ElectronTemperature
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/ElectronTemperature
 
                                                          
 
-!syntax description /AuxKernels/ElectronTemperature
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • mean_enThe logarathmic representation of the mean energy.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The logarathmic representation of the mean energy.
                                                          • electron_densityThe electron density
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/Position.html b/source/auxkernels/Position.html index 2d65917d34c..a5523e9c186 100644 --- a/source/auxkernels/Position.html +++ b/source/auxkernels/Position.html @@ -1,4 +1,4 @@ -Position|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          Position

                                                          under construction:Undocumented Class

                                                          The Position has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+Position|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          Position
                                                          under construction:Undocumented Class
                                                          The Position has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # Position
 
 !syntax description /AuxKernels/Position
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/Position
 
                                                          
 
-!syntax description /AuxKernels/Position
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/PowerDep.html b/source/auxkernels/PowerDep.html index 2472138d249..84326bacec4 100644 --- a/source/auxkernels/PowerDep.html +++ b/source/auxkernels/PowerDep.html @@ -1,4 +1,4 @@ -PowerDep|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          PowerDep

                                                          under construction:Undocumented Class

                                                          The PowerDep has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+PowerDep|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          PowerDep
                                                          under construction:Undocumented Class
                                                          The PowerDep has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # PowerDep
 
 !syntax description /AuxKernels/PowerDep
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/PowerDep
 
                                                          
 
-!syntax description /AuxKernels/PowerDep
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe electron density
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density
                                                          • potentialThe potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential
                                                          • potential_unitsThe potential units.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The potential units.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • art_diffFalseWhether there is a current contribution from artificial diffusion.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether there is a current contribution from artificial diffusion.
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/ProcRate.html b/source/auxkernels/ProcRate.html index 75d40b85298..8a3815ddf16 100644 --- a/source/auxkernels/ProcRate.html +++ b/source/auxkernels/ProcRate.html @@ -1,4 +1,4 @@ -ProcRate|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ProcRate

                                                          under construction:Undocumented Class

                                                          The ProcRate has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ProcRate|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ProcRate
                                                          under construction:Undocumented Class
                                                          The ProcRate has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ProcRate
 
 !syntax description /AuxKernels/ProcRate
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/ProcRate
 
                                                          
 
-!syntax description /AuxKernels/ProcRate
                                                          Input Parameters
                                                          • emThe electron density
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • potentialThe potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential
                                                          • procThe process that we want to get the townsend coefficient for. Options are iz, ex, and el.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The process that we want to get the townsend coefficient for. Options are iz, ex, and el.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/ProcRateForRateCoeff.html b/source/auxkernels/ProcRateForRateCoeff.html index 455193d4453..95d79d2a5cb 100644 --- a/source/auxkernels/ProcRateForRateCoeff.html +++ b/source/auxkernels/ProcRateForRateCoeff.html @@ -1,4 +1,4 @@ -ProcRateForRateCoeff|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ProcRateForRateCoeff

                                                          under construction:Undocumented Class

                                                          The ProcRateForRateCoeff has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ProcRateForRateCoeff|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ProcRateForRateCoeff
                                                          under construction:Undocumented Class
                                                          The ProcRateForRateCoeff has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ProcRateForRateCoeff
 
 !syntax description /AuxKernels/ProcRateForRateCoeff
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/ProcRateForRateCoeff
 
                                                          
 
-!syntax description /AuxKernels/ProcRateForRateCoeff
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • reactionThe full reaction equation.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The full reaction equation.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • wThe second variable that is reacting to create u.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The second variable that is reacting to create u.
                                                          • vThe first variable that is reacting to create u.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The first variable that is reacting to create u.
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/ProcRateForRateCoeffThreeBody.html b/source/auxkernels/ProcRateForRateCoeffThreeBody.html index 525fb4eb166..81e7c270d9b 100644 --- a/source/auxkernels/ProcRateForRateCoeffThreeBody.html +++ b/source/auxkernels/ProcRateForRateCoeffThreeBody.html @@ -1,4 +1,4 @@ -ProcRateForRateCoeffThreeBody|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ProcRateForRateCoeffThreeBody

                                                          under construction:Undocumented Class

                                                          The ProcRateForRateCoeffThreeBody has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ProcRateForRateCoeffThreeBody|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ProcRateForRateCoeffThreeBody
                                                          under construction:Undocumented Class
                                                          The ProcRateForRateCoeffThreeBody has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ProcRateForRateCoeffThreeBody
 
 !syntax description /AuxKernels/ProcRateForRateCoeffThreeBody
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/ProcRateForRateCoeffThreeBody
 
                                                          
 
-!syntax description /AuxKernels/ProcRateForRateCoeffThreeBody
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • reactionThe full reaction equation.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The full reaction equation.
                                                          Required Parameters
                                                          • vvThe second variable that is reacting to create u.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The second variable that is reacting to create u.
                                                          • wThe second variable that is reacting to create u.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The second variable that is reacting to create u.
                                                          • vThe first variable that is reacting to create u.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The first variable that is reacting to create u.
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/Sigma.html b/source/auxkernels/Sigma.html index 5a74b108a9c..8cd4a0813c7 100644 --- a/source/auxkernels/Sigma.html +++ b/source/auxkernels/Sigma.html @@ -1,4 +1,4 @@ -Sigma|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          Sigma

                                                          under construction:Undocumented Class

                                                          The Sigma has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+Sigma|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          Sigma
                                                          under construction:Undocumented Class
                                                          The Sigma has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # Sigma
 
 !syntax description /AuxKernels/Sigma
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/Sigma
 
                                                          
 
-!syntax description /AuxKernels/Sigma
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • potentialThe potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential
                                                          • nThe density of the ions.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The density of the ions.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/TM0CylindricalErAux.html b/source/auxkernels/TM0CylindricalErAux.html index cb19f615a57..6800a78c8ae 100644 --- a/source/auxkernels/TM0CylindricalErAux.html +++ b/source/auxkernels/TM0CylindricalErAux.html @@ -1,4 +1,4 @@ -TM 0 CylindricalErAux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          TM0CylindricalErAux

                                                          under construction:Undocumented Class

                                                          The TM0CylindricalErAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+TM 0 CylindricalErAux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          TM0CylindricalErAux
                                                          under construction:Undocumented Class
                                                          The TM0CylindricalErAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # TM0CylindricalErAux
 
 !syntax description /AuxKernels/TM0CylindricalErAux
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/TM0CylindricalErAux
 
                                                          
 
-!syntax description /AuxKernels/TM0CylindricalErAux
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • HphiMagnetic field component Hphi.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Magnetic field component Hphi.
                                                          • fThe drive frequency.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The drive frequency.
                                                          Required Parameters
                                                          • eps_r1The relative permittivity of the medium.
                                                            Default:1
                                                            C++ Type:double
                                                            Options:
                                                            Description:The relative permittivity of the medium.
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/TM0CylindricalEzAux.html b/source/auxkernels/TM0CylindricalEzAux.html index 9fbeaee7b1f..84ad629ce81 100644 --- a/source/auxkernels/TM0CylindricalEzAux.html +++ b/source/auxkernels/TM0CylindricalEzAux.html @@ -1,4 +1,4 @@ -TM 0 CylindricalEzAux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          TM0CylindricalEzAux

                                                          under construction:Undocumented Class

                                                          The TM0CylindricalEzAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+TM 0 CylindricalEzAux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          TM0CylindricalEzAux
                                                          under construction:Undocumented Class
                                                          The TM0CylindricalEzAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # TM0CylindricalEzAux
 
 !syntax description /AuxKernels/TM0CylindricalEzAux
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/TM0CylindricalEzAux
 
                                                          
 
-!syntax description /AuxKernels/TM0CylindricalEzAux
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • HphiMagnetic field component Hphi.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Magnetic field component Hphi.
                                                          • fThe drive frequency.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The drive frequency.
                                                          Required Parameters
                                                          • eps_r1The relative permittivity of the medium.
                                                            Default:1
                                                            C++ Type:double
                                                            Options:
                                                            Description:The relative permittivity of the medium.
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/TotalFlux.html b/source/auxkernels/TotalFlux.html index b392fc50b6a..3c8390228e8 100644 --- a/source/auxkernels/TotalFlux.html +++ b/source/auxkernels/TotalFlux.html @@ -1,4 +1,4 @@ -TotalFlux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          TotalFlux

                                                          under construction:Undocumented Class

                                                          The TotalFlux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+TotalFlux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          TotalFlux
                                                          under construction:Undocumented Class
                                                          The TotalFlux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # TotalFlux
 
 !syntax description /AuxKernels/TotalFlux
@@ -18,7 +18,7 @@
 !syntax children /AuxKernels/TotalFlux
 
                                                          
 
-!syntax description /AuxKernels/TotalFlux
                                                          Input Parameters
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe electron density
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density
                                                          • potentialThe potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/auxkernels/UserFlux.html b/source/auxkernels/UserFlux.html index 0986abbf4ee..3eb6c611ed7 100644 --- a/source/auxkernels/UserFlux.html +++ b/source/auxkernels/UserFlux.html @@ -1,4 +1,4 @@ -UserFlux|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          UserFlux

                                                          under construction:Undocumented Class

                                                          The UserFlux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+UserFlux|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          UserFlux
                                                          under construction:Undocumented Class
                                                          The UserFlux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # UserFlux
 
 !syntax description /AuxKernels/UserFlux
@@ -18,4 +18,4 @@
 !syntax children /AuxKernels/UserFlux
 
                                                          
 
-!syntax description /AuxKernels/UserFlux
                                                          Input Parameters
                                                          • signThe charge sign of the drift-diffusing particle.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The charge sign of the drift-diffusing particle.
                                                          • muThe mobility.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The mobility.
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe electron density
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density
                                                          • diffThe diffusivity.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The diffusivity.
                                                          • EFieldThe electric field moving the charges.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The electric field moving the charges.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          
\ No newline at end of file
+!syntax description /AuxKernels/UserFlux
                                                          Input Parameters
                                                          • signThe charge sign of the drift-diffusing particle.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The charge sign of the drift-diffusing particle.
                                                          • muThe mobility.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The mobility.
                                                          • variableThe name of the variable that this object applies to
                                                            C++ Type:AuxVariableName
                                                            Options:
                                                            Description:The name of the variable that this object applies to
                                                          • density_logThe electron density
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density
                                                          • diffThe diffusivity.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The diffusivity.
                                                          • EFieldThe electric field moving the charges.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The electric field moving the charges.
                                                          Required Parameters
                                                          • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                            Default:LINEAR TIMESTEP_END
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          \ No newline at end of file diff --git a/source/bcs/CircuitDirichletPotential.html b/source/bcs/CircuitDirichletPotential.html index 4a143f8ea79..7a4bfe1c227 100644 --- a/source/bcs/CircuitDirichletPotential.html +++ b/source/bcs/CircuitDirichletPotential.html @@ -1,4 +1,4 @@ -CircuitDirichletPotential|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          CircuitDirichletPotential

                                                          under construction:Undocumented Class

                                                          The CircuitDirichletPotential has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+CircuitDirichletPotential|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          CircuitDirichletPotential
                                                          under construction:Undocumented Class
                                                          The CircuitDirichletPotential has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # CircuitDirichletPotential
 
 !syntax description /BCs/CircuitDirichletPotential
@@ -18,7 +18,7 @@
 !syntax children /BCs/CircuitDirichletPotential
 
                                                          
 
-!syntax description /BCs/CircuitDirichletPotential
                                                          Input Parameters
                                                          • currentThe postprocessor response for calculating the current passing through the needle surface.
                                                            C++ Type:PostprocessorName
                                                            Options:
                                                            Description:The postprocessor response for calculating the current passing through the needle surface.
                                                          • surface_potentialThe electrical potential applied to the surface if no current was flowing in the circuit.
                                                            C++ Type:FunctionName
                                                            Options:
                                                            Description:The electrical potential applied to the surface if no current was flowing in the circuit.
                                                          • surfaceWhether you are specifying the potential on the anode or the cathode with the requirement that the other metal surface be grounded.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:Whether you are specifying the potential on the anode or the cathode with the requirement that the other metal surface be grounded.
                                                          • resistThe ballast resistance in Ohms
                                                            C++ Type:double
                                                            Options:
                                                            Description:The ballast resistance in Ohms
                                                          • use_molesFalseWhether to convert from units of moles to #.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether to convert from units of moles to #.
                                                          • position_unitsUnits of position
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potential_unitsThe potential units.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The potential units.
                                                          Required Parameters
                                                          • A1For 1D calculations, an area has to be passed. This area also must match the units convention of position_units.
                                                            Default:1
                                                            C++ Type:double
                                                            Options:
                                                            Description:For 1D calculations, an area has to be passed. This area also must match the units convention of position_units.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          Optional Parameters
                                                          • vector_tagsresidualThe tag for the vectors this Kernel should fill
                                                            Default:residual
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time residual
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystem timeThe tag for the matrices this Kernel should fill
                                                            Default:system time
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system time
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/DCIonBC.html b/source/bcs/DCIonBC.html index 85cbd955d2d..50be8c4ed0e 100644 --- a/source/bcs/DCIonBC.html +++ b/source/bcs/DCIonBC.html @@ -1,4 +1,4 @@ -DCIonBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DCIonBC

                                                          under construction:Undocumented Class

                                                          The DCIonBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DCIonBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DCIonBC
                                                          under construction:Undocumented Class
                                                          The DCIonBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DCIonBC
 
 !syntax description /BCs/DCIonBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/DCIonBC
 
                                                          
 
-!syntax description /BCs/DCIonBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe electrical potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electrical potential
                                                          • position_unitsUnits of position
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/DriftDiffusionDoNothingBC.html b/source/bcs/DriftDiffusionDoNothingBC.html index 1e8db0118ee..eaf320cbfc1 100644 --- a/source/bcs/DriftDiffusionDoNothingBC.html +++ b/source/bcs/DriftDiffusionDoNothingBC.html @@ -1,4 +1,4 @@ -DriftDiffusionDoNothingBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DriftDiffusionDoNothingBC

                                                          under construction:Undocumented Class

                                                          The DriftDiffusionDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DriftDiffusionDoNothingBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DriftDiffusionDoNothingBC
                                                          under construction:Undocumented Class
                                                          The DriftDiffusionDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DriftDiffusionDoNothingBC
 
 !syntax description /BCs/DriftDiffusionDoNothingBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/DriftDiffusionDoNothingBC
 
                                                          
 
-!syntax description /BCs/DriftDiffusionDoNothingBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                            C++ Type:double
                                                            Options:
                                                            Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                          • muThe mobility.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The mobility.
                                                          • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The gradient of the potential will be used to compute the advection velocity.
                                                          • use_material_propsTrueWhether to use a material for properties.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether to use a material for properties.
                                                          • diffThe diffusivity.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The diffusivity.
                                                          • signThe sign of the charged particle.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The sign of the charged particle.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Child Objects
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/DriftDiffusionUserDoNothingBC.html b/source/bcs/DriftDiffusionUserDoNothingBC.html index a6821b3ed45..ff2c531ac36 100644 --- a/source/bcs/DriftDiffusionUserDoNothingBC.html +++ b/source/bcs/DriftDiffusionUserDoNothingBC.html @@ -1,4 +1,4 @@ -DriftDiffusionUserDoNothingBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DriftDiffusionUserDoNothingBC

                                                          under construction:Undocumented Class

                                                          The DriftDiffusionUserDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DriftDiffusionUserDoNothingBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DriftDiffusionUserDoNothingBC
                                                          under construction:Undocumented Class
                                                          The DriftDiffusionUserDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DriftDiffusionUserDoNothingBC
 
 !syntax description /BCs/DriftDiffusionUserDoNothingBC
@@ -18,4 +18,4 @@
 !syntax children /BCs/DriftDiffusionUserDoNothingBC
 
                                                          
 
-!syntax description /BCs/DriftDiffusionUserDoNothingBC
                                                          Input Parameters
                                                          • signThe charge sign of the drift-diffusing particle.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The charge sign of the drift-diffusing particle.
                                                          • muThe mobility.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The mobility.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • diffThe diffusivity.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The diffusivity.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          Required Parameters
                                                          • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The gradient of the potential will be used to compute the advection velocity.
                                                          • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                            C++ Type:double
                                                            Options:
                                                            Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                          • use_material_propsTrueWhether to use a material for properties.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether to use a material for properties.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          
\ No newline at end of file
+!syntax description /BCs/DriftDiffusionUserDoNothingBC
                                                          Input Parameters
                                                          • signThe charge sign of the drift-diffusing particle.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The charge sign of the drift-diffusing particle.
                                                          • muThe mobility.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The mobility.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • diffThe diffusivity.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The diffusivity.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          Required Parameters
                                                          • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The gradient of the potential will be used to compute the advection velocity.
                                                          • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                            C++ Type:double
                                                            Options:
                                                            Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                          • use_material_propsTrueWhether to use a material for properties.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether to use a material for properties.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          \ No newline at end of file diff --git a/source/bcs/ElectronAdvectionDoNothingBC.html b/source/bcs/ElectronAdvectionDoNothingBC.html index f7a50a033e8..95fb83528d6 100644 --- a/source/bcs/ElectronAdvectionDoNothingBC.html +++ b/source/bcs/ElectronAdvectionDoNothingBC.html @@ -1,4 +1,4 @@ -ElectronAdvectionDoNothingBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ElectronAdvectionDoNothingBC

                                                          under construction:Undocumented Class

                                                          The ElectronAdvectionDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ElectronAdvectionDoNothingBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ElectronAdvectionDoNothingBC
                                                          under construction:Undocumented Class
                                                          The ElectronAdvectionDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ElectronAdvectionDoNothingBC
 
 !syntax description /BCs/ElectronAdvectionDoNothingBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/ElectronAdvectionDoNothingBC
 
                                                          
 
-!syntax description /BCs/ElectronAdvectionDoNothingBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The gradient of the potential will be used to compute the advection velocity.
                                                          • mean_enThe log of the mean energy.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The log of the mean energy.
                                                          • position_unitsThe units of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The units of position.
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/ElectronDiffusionDoNothingBC.html b/source/bcs/ElectronDiffusionDoNothingBC.html index 234988b395d..b6bd80dd058 100644 --- a/source/bcs/ElectronDiffusionDoNothingBC.html +++ b/source/bcs/ElectronDiffusionDoNothingBC.html @@ -1,4 +1,4 @@ -ElectronDiffusionDoNothingBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ElectronDiffusionDoNothingBC

                                                          under construction:Undocumented Class

                                                          The ElectronDiffusionDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ElectronDiffusionDoNothingBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ElectronDiffusionDoNothingBC
                                                          under construction:Undocumented Class
                                                          The ElectronDiffusionDoNothingBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ElectronDiffusionDoNothingBC
 
 !syntax description /BCs/ElectronDiffusionDoNothingBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/ElectronDiffusionDoNothingBC
 
                                                          
 
-!syntax description /BCs/ElectronDiffusionDoNothingBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • mean_enThe log of the product of mean energy times electron density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The log of the product of mean energy times electron density.
                                                          • position_unitsUnits of position
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/ElectronTemperatureDirichletBC.html b/source/bcs/ElectronTemperatureDirichletBC.html index 3f6756810ae..ca9bae5ae86 100644 --- a/source/bcs/ElectronTemperatureDirichletBC.html +++ b/source/bcs/ElectronTemperatureDirichletBC.html @@ -1,4 +1,4 @@ -ElectronTemperatureDirichletBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ElectronTemperatureDirichletBC

                                                          under construction:Undocumented Class

                                                          The ElectronTemperatureDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ElectronTemperatureDirichletBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ElectronTemperatureDirichletBC
                                                          under construction:Undocumented Class
                                                          The ElectronTemperatureDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ElectronTemperatureDirichletBC
 
 !syntax description /BCs/ElectronTemperatureDirichletBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/ElectronTemperatureDirichletBC
 
                                                          
 
-!syntax description /BCs/ElectronTemperatureDirichletBC
                                                          Input Parameters
                                                          • emThe electron density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • valueValue of the BC
                                                            C++ Type:double
                                                            Options:
                                                            Description:Value of the BC
                                                          Required Parameters
                                                          • penalty_value1The penalty value for the Dirichlet BC.
                                                            Default:1
                                                            C++ Type:double
                                                            Options:
                                                            Description:The penalty value for the Dirichlet BC.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsresidualThe tag for the vectors this Kernel should fill
                                                            Default:residual
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time residual
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystem timeThe tag for the matrices this Kernel should fill
                                                            Default:system time
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system time
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/FieldEmissionBC.html b/source/bcs/FieldEmissionBC.html index 8ce49f63358..f08a85f35e8 100644 --- a/source/bcs/FieldEmissionBC.html +++ b/source/bcs/FieldEmissionBC.html @@ -1,4 +1,4 @@ -FieldEmissionBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          FieldEmissionBC

                                                          under construction:Undocumented Class

                                                          The FieldEmissionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+FieldEmissionBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          FieldEmissionBC
                                                          under construction:Undocumented Class
                                                          The FieldEmissionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # FieldEmissionBC
 
 !syntax description /BCs/FieldEmissionBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/FieldEmissionBC
 
                                                          
 
-!syntax description /BCs/FieldEmissionBC
                                                          Input Parameters
                                                          • mean_enThe mean energy.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The mean energy.
                                                          • ipThe ion density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion density.
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • potential_unitsThe potential units.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The potential units.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          Required Parameters
                                                          • tau1e-09The time constant for ramping the boundary condition.
                                                            Default:1e-09
                                                            C++ Type:double
                                                            Options:
                                                            Description:The time constant for ramping the boundary condition.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          • relaxFalseUse relaxation for emission.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Use relaxation for emission.
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/HagelaarElectronAdvectionBC.html b/source/bcs/HagelaarElectronAdvectionBC.html index dcb9863c778..495a53487e2 100644 --- a/source/bcs/HagelaarElectronAdvectionBC.html +++ b/source/bcs/HagelaarElectronAdvectionBC.html @@ -1,4 +1,4 @@ -HagelaarElectronAdvectionBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HagelaarElectronAdvectionBC

                                                          under construction:Undocumented Class

                                                          The HagelaarElectronAdvectionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+HagelaarElectronAdvectionBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          HagelaarElectronAdvectionBC
                                                          under construction:Undocumented Class
                                                          The HagelaarElectronAdvectionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # HagelaarElectronAdvectionBC
 
 !syntax description /BCs/HagelaarElectronAdvectionBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/HagelaarElectronAdvectionBC
 
                                                          
 
-!syntax description /BCs/HagelaarElectronAdvectionBC
                                                          Input Parameters
                                                          • mean_enThe mean energy.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The mean energy.
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/HagelaarElectronBC.html b/source/bcs/HagelaarElectronBC.html index b8202904519..bad9e44cca8 100644 --- a/source/bcs/HagelaarElectronBC.html +++ b/source/bcs/HagelaarElectronBC.html @@ -1,4 +1,4 @@ -HagelaarElectronBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HagelaarElectronBC

                                                          under construction:Undocumented Class

                                                          The HagelaarElectronBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+HagelaarElectronBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          HagelaarElectronBC
                                                          under construction:Undocumented Class
                                                          The HagelaarElectronBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # HagelaarElectronBC
 
 !syntax description /BCs/HagelaarElectronBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/HagelaarElectronBC
 
                                                          
 
-!syntax description /BCs/HagelaarElectronBC
                                                          Input Parameters
                                                          • mean_enThe mean energy.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The mean energy.
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/HagelaarEnergyAdvectionBC.html b/source/bcs/HagelaarEnergyAdvectionBC.html index 538876b7738..2f641370acd 100644 --- a/source/bcs/HagelaarEnergyAdvectionBC.html +++ b/source/bcs/HagelaarEnergyAdvectionBC.html @@ -1,4 +1,4 @@ -HagelaarEnergyAdvectionBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HagelaarEnergyAdvectionBC

                                                          under construction:Undocumented Class

                                                          The HagelaarEnergyAdvectionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+HagelaarEnergyAdvectionBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          HagelaarEnergyAdvectionBC
                                                          under construction:Undocumented Class
                                                          The HagelaarEnergyAdvectionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # HagelaarEnergyAdvectionBC
 
 !syntax description /BCs/HagelaarEnergyAdvectionBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/HagelaarEnergyAdvectionBC
 
                                                          
 
-!syntax description /BCs/HagelaarEnergyAdvectionBC
                                                          Input Parameters
                                                          • emThe electron density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density.
                                                          • ipThe ion density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion density.
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/HagelaarEnergyBC.html b/source/bcs/HagelaarEnergyBC.html index 478cda27e52..0bc1d859754 100644 --- a/source/bcs/HagelaarEnergyBC.html +++ b/source/bcs/HagelaarEnergyBC.html @@ -1,4 +1,4 @@ -HagelaarEnergyBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HagelaarEnergyBC

                                                          under construction:Undocumented Class

                                                          The HagelaarEnergyBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+HagelaarEnergyBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          HagelaarEnergyBC
                                                          under construction:Undocumented Class
                                                          The HagelaarEnergyBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # HagelaarEnergyBC
 
 !syntax description /BCs/HagelaarEnergyBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/HagelaarEnergyBC
 
                                                          
 
-!syntax description /BCs/HagelaarEnergyBC
                                                          Input Parameters
                                                          • emThe electron density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron density.
                                                          • ipThe ion density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion density.
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/HagelaarIonAdvectionBC.html b/source/bcs/HagelaarIonAdvectionBC.html index 13b9788fdfc..3a808f5fb0f 100644 --- a/source/bcs/HagelaarIonAdvectionBC.html +++ b/source/bcs/HagelaarIonAdvectionBC.html @@ -1,4 +1,4 @@ -HagelaarIonAdvectionBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HagelaarIonAdvectionBC

                                                          under construction:Undocumented Class

                                                          The HagelaarIonAdvectionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+HagelaarIonAdvectionBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          HagelaarIonAdvectionBC
                                                          under construction:Undocumented Class
                                                          The HagelaarIonAdvectionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # HagelaarIonAdvectionBC
 
 !syntax description /BCs/HagelaarIonAdvectionBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/HagelaarIonAdvectionBC
 
                                                          
 
-!syntax description /BCs/HagelaarIonAdvectionBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/HagelaarIonDiffusionBC.html b/source/bcs/HagelaarIonDiffusionBC.html index 81f315d9dc8..a933490b2be 100644 --- a/source/bcs/HagelaarIonDiffusionBC.html +++ b/source/bcs/HagelaarIonDiffusionBC.html @@ -1,4 +1,4 @@ -HagelaarIonDiffusionBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          HagelaarIonDiffusionBC

                                                          under construction:Undocumented Class

                                                          The HagelaarIonDiffusionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+HagelaarIonDiffusionBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          HagelaarIonDiffusionBC
                                                          under construction:Undocumented Class
                                                          The HagelaarIonDiffusionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # HagelaarIonDiffusionBC
 
 !syntax description /BCs/HagelaarIonDiffusionBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/HagelaarIonDiffusionBC
 
                                                          
 
-!syntax description /BCs/HagelaarIonDiffusionBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • user_velocity-1Optional parameter if user wants to specify the thermal velocity
                                                            Default:-1
                                                            C++ Type:double
                                                            Options:
                                                            Description:Optional parameter if user wants to specify the thermal velocity
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/LogDensityDirichletBC.html b/source/bcs/LogDensityDirichletBC.html index 9b3b39d9f9d..bf3469dc1cc 100644 --- a/source/bcs/LogDensityDirichletBC.html +++ b/source/bcs/LogDensityDirichletBC.html @@ -1,4 +1,4 @@ -LogDensityDirichletBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          LogDensityDirichletBC

                                                          under construction:Undocumented Class

                                                          The LogDensityDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+LogDensityDirichletBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          LogDensityDirichletBC
                                                          under construction:Undocumented Class
                                                          The LogDensityDirichletBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # LogDensityDirichletBC
 
 !syntax description /BCs/LogDensityDirichletBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/LogDensityDirichletBC
 
                                                          
 
-!syntax description /BCs/LogDensityDirichletBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • valueValue of the BC
                                                            C++ Type:double
                                                            Options:
                                                            Description:Value of the BC
                                                          Required Parameters
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsresidualThe tag for the vectors this Kernel should fill
                                                            Default:residual
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time residual
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystem timeThe tag for the matrices this Kernel should fill
                                                            Default:system time
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system time
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/LymberopoulosElectronBC.html b/source/bcs/LymberopoulosElectronBC.html index e575adc4193..c3c68f5c59c 100644 --- a/source/bcs/LymberopoulosElectronBC.html +++ b/source/bcs/LymberopoulosElectronBC.html @@ -1,4 +1,4 @@ -LymberopoulosElectronBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          LymberopoulosElectronBC

                                                          under construction:Undocumented Class

                                                          The LymberopoulosElectronBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+LymberopoulosElectronBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          LymberopoulosElectronBC
                                                          under construction:Undocumented Class
                                                          The LymberopoulosElectronBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # LymberopoulosElectronBC
 
 !syntax description /BCs/LymberopoulosElectronBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/LymberopoulosElectronBC
 
                                                          
 
-!syntax description /BCs/LymberopoulosElectronBC
                                                          Input Parameters
                                                          • ksThe recombination coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The recombination coefficient
                                                          • ionThe ion density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion density.
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • gammaThe secondary electron coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The secondary electron coefficient
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/LymberopoulosIonBC.html b/source/bcs/LymberopoulosIonBC.html index 99385765849..7f3d8852c6c 100644 --- a/source/bcs/LymberopoulosIonBC.html +++ b/source/bcs/LymberopoulosIonBC.html @@ -1,4 +1,4 @@ -LymberopoulosIonBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          LymberopoulosIonBC

                                                          under construction:Undocumented Class

                                                          The LymberopoulosIonBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+LymberopoulosIonBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          LymberopoulosIonBC
                                                          under construction:Undocumented Class
                                                          The LymberopoulosIonBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # LymberopoulosIonBC
 
 !syntax description /BCs/LymberopoulosIonBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/LymberopoulosIonBC
 
                                                          
 
-!syntax description /BCs/LymberopoulosIonBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/NeumannCircuitVoltageMoles_KV.html b/source/bcs/NeumannCircuitVoltageMoles_KV.html index 65bfd66cbff..41c6bd9ed6d 100644 --- a/source/bcs/NeumannCircuitVoltageMoles_KV.html +++ b/source/bcs/NeumannCircuitVoltageMoles_KV.html @@ -1,4 +1,4 @@ -NeumannCircuitVoltageMoles KV|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          NeumannCircuitVoltageMoles_KV

                                                          under construction:Undocumented Class

                                                          The NeumannCircuitVoltageMoles_KV has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+NeumannCircuitVoltageMoles KV|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          NeumannCircuitVoltageMoles_KV
                                                          under construction:Undocumented Class
                                                          The NeumannCircuitVoltageMoles_KV has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # NeumannCircuitVoltageMoles_KV
 
 !syntax description /BCs/NeumannCircuitVoltageMoles_KV
@@ -18,7 +18,7 @@
 !syntax children /BCs/NeumannCircuitVoltageMoles_KV
 
                                                          
 
-!syntax description /BCs/NeumannCircuitVoltageMoles_KV
                                                          Input Parameters
                                                          • emThe log of the electron density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The log of the electron density.
                                                          • functionThe function.
                                                            C++ Type:FunctionName
                                                            Options:
                                                            Description:The function.
                                                          • mean_enThe log of the product of the mean energy and the electron density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The log of the product of the mean energy and the electron density.
                                                          • ipThe ion density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion density.
                                                          • rThe reflection coefficient applied to both electrons and ions
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient applied to both electrons and ions
                                                          • potential_unitsThe potential units.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The potential units.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • data_providerThe name of the UserObject that can provide some data to materials, bcs, etc.
                                                            C++ Type:UserObjectName
                                                            Options:
                                                            Description:The name of the UserObject that can provide some data to materials, bcs, etc.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/PenaltyCircuitPotential.html b/source/bcs/PenaltyCircuitPotential.html index c03bb8145d8..6c5fce3dc9d 100644 --- a/source/bcs/PenaltyCircuitPotential.html +++ b/source/bcs/PenaltyCircuitPotential.html @@ -1,4 +1,4 @@ -PenaltyCircuitPotential|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          PenaltyCircuitPotential

                                                          under construction:Undocumented Class

                                                          The PenaltyCircuitPotential has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+PenaltyCircuitPotential|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          PenaltyCircuitPotential
                                                          under construction:Undocumented Class
                                                          The PenaltyCircuitPotential has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # PenaltyCircuitPotential
 
 !syntax description /BCs/PenaltyCircuitPotential
@@ -18,7 +18,7 @@
 !syntax children /BCs/PenaltyCircuitPotential
 
                                                          
 
-!syntax description /BCs/PenaltyCircuitPotential
                                                          Input Parameters
                                                          • emThe electron variable.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electron variable.
                                                          • currentThe postprocessor response for calculating the current passing through the needle surface.
                                                            C++ Type:UserObjectName
                                                            Options:
                                                            Description:The postprocessor response for calculating the current passing through the needle surface.
                                                          • mean_enThe ion variable.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion variable.
                                                          • ipThe ion variable.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion variable.
                                                          • surface_potentialThe electrical potential applied to the surface if no current was flowing in the circuit.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The electrical potential applied to the surface if no current was flowing in the circuit.
                                                          • resistanceThe ballast resistance in Ohms.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The ballast resistance in Ohms.
                                                          • surfaceWhether you are specifying the potential on the anode or the cathode with the requirement that the other metal surface be grounded.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:Whether you are specifying the potential on the anode or the cathode with the requirement that the other metal surface be grounded.
                                                          • penaltyThe constant multiplying the penalty term.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The constant multiplying the penalty term.
                                                          • potential_unitsThe potential units.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The potential units.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • data_providerThe name of the UserObject that can provide some data to materials, bcs, etc.
                                                            C++ Type:UserObjectName
                                                            Options:
                                                            Description:The name of the UserObject that can provide some data to materials, bcs, etc.
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          • areaMust be provided when the number of dimensions equals 1.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Must be provided when the number of dimensions equals 1.
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/PotentialDriftOutflowBC.html b/source/bcs/PotentialDriftOutflowBC.html index ea550328853..d4254badb22 100644 --- a/source/bcs/PotentialDriftOutflowBC.html +++ b/source/bcs/PotentialDriftOutflowBC.html @@ -1,4 +1,4 @@ -PotentialDriftOutflowBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          PotentialDriftOutflowBC

                                                          under construction:Undocumented Class

                                                          The PotentialDriftOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+PotentialDriftOutflowBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          PotentialDriftOutflowBC
                                                          under construction:Undocumented Class
                                                          The PotentialDriftOutflowBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # PotentialDriftOutflowBC
 
 !syntax description /BCs/PotentialDriftOutflowBC
@@ -18,4 +18,4 @@
 !syntax children /BCs/PotentialDriftOutflowBC
 
                                                          
 
-!syntax description /BCs/PotentialDriftOutflowBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The gradient of the potential will be used to compute the advection velocity.
                                                          Required Parameters
                                                          • charge_signpositiveThe sign of the charged particle.
                                                            Default:positive
                                                            C++ Type:MooseEnum
                                                            Options:negative positive
                                                            Description:The sign of the charged particle.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          
\ No newline at end of file
+!syntax description /BCs/PotentialDriftOutflowBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The gradient of the potential will be used to compute the advection velocity.
                                                          Required Parameters
                                                          • charge_signpositiveThe sign of the charged particle.
                                                            Default:positive
                                                            C++ Type:MooseEnum
                                                            Options:negative positive
                                                            Description:The sign of the charged particle.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          \ No newline at end of file diff --git a/source/bcs/SchottkyEmissionBC.html b/source/bcs/SchottkyEmissionBC.html index 4b377ece5f5..84b2a997877 100644 --- a/source/bcs/SchottkyEmissionBC.html +++ b/source/bcs/SchottkyEmissionBC.html @@ -1,4 +1,4 @@ -SchottkyEmissionBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          SchottkyEmissionBC

                                                          under construction:Undocumented Class

                                                          The SchottkyEmissionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+SchottkyEmissionBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          SchottkyEmissionBC
                                                          under construction:Undocumented Class
                                                          The SchottkyEmissionBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # SchottkyEmissionBC
 
 !syntax description /BCs/SchottkyEmissionBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/SchottkyEmissionBC
 
                                                          
 
-!syntax description /BCs/SchottkyEmissionBC
                                                          Input Parameters
                                                          • mean_enThe mean energy.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The mean energy.
                                                          • ipThe ion density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion density.
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • potential_unitsThe potential units.
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:The potential units.
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          Required Parameters
                                                          • tau1e-09The time constant for ramping the boundary condition.
                                                            Default:1e-09
                                                            C++ Type:double
                                                            Options:
                                                            Description:The time constant for ramping the boundary condition.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          • relaxFalseUse relaxation for emission.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Use relaxation for emission.
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/SecondaryElectronBC.html b/source/bcs/SecondaryElectronBC.html index a69df21605c..f641fa73139 100644 --- a/source/bcs/SecondaryElectronBC.html +++ b/source/bcs/SecondaryElectronBC.html @@ -1,4 +1,4 @@ -SecondaryElectronBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          SecondaryElectronBC

                                                          under construction:Undocumented Class

                                                          The SecondaryElectronBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+SecondaryElectronBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          SecondaryElectronBC
                                                          under construction:Undocumented Class
                                                          The SecondaryElectronBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # SecondaryElectronBC
 
 !syntax description /BCs/SecondaryElectronBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/SecondaryElectronBC
 
                                                          
 
-!syntax description /BCs/SecondaryElectronBC
                                                          Input Parameters
                                                          • mean_enThe mean energy.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The mean energy.
                                                          • ipThe ion density.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The ion density.
                                                          • potentialThe electric potential
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The electric potential
                                                          • position_unitsUnits of position.
                                                            C++ Type:double
                                                            Options:
                                                            Description:Units of position.
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • rThe reflection coefficient
                                                            C++ Type:double
                                                            Options:
                                                            Description:The reflection coefficient
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/TM0AntennaVertBC.html b/source/bcs/TM0AntennaVertBC.html index f6cbb5600da..23cf1b23d94 100644 --- a/source/bcs/TM0AntennaVertBC.html +++ b/source/bcs/TM0AntennaVertBC.html @@ -1,4 +1,4 @@ -TM 0 AntennaVertBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          TM0AntennaVertBC

                                                          under construction:Undocumented Class

                                                          The TM0AntennaVertBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+TM 0 AntennaVertBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          TM0AntennaVertBC
                                                          under construction:Undocumented Class
                                                          The TM0AntennaVertBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # TM0AntennaVertBC
 
 !syntax description /BCs/TM0AntennaVertBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/TM0AntennaVertBC
 
                                                          
 
-!syntax description /BCs/TM0AntennaVertBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • fThe drive frequency.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The drive frequency.
                                                          Required Parameters
                                                          • eps_r1The relative permittivity.
                                                            Default:1
                                                            C++ Type:double
                                                            Options:
                                                            Description:The relative permittivity.
                                                          • time_dependentFalseWhether the antenna boundary condition should oscillate in time.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether the antenna boundary condition should oscillate in time.
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/bcs/TM0PECVertBC.html b/source/bcs/TM0PECVertBC.html index 5a053770111..104f14f8cf3 100644 --- a/source/bcs/TM0PECVertBC.html +++ b/source/bcs/TM0PECVertBC.html @@ -1,4 +1,4 @@ -TM 0 PECVertBC|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          TM0PECVertBC

                                                          under construction:Undocumented Class

                                                          The TM0PECVertBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+TM 0 PECVertBC|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          TM0PECVertBC
                                                          under construction:Undocumented Class
                                                          The TM0PECVertBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # TM0PECVertBC
 
 !syntax description /BCs/TM0PECVertBC
@@ -18,7 +18,7 @@
 !syntax children /BCs/TM0PECVertBC
 
                                                          
 
-!syntax description /BCs/TM0PECVertBC
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          Required Parameters
                                                          • displacementsThe displacements
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The displacements
                                                          Optional Parameters
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • save_inThe name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • seed0The seed for the master random number generator
                                                            Default:0
                                                            C++ Type:unsigned int
                                                            Options:
                                                            Description:The seed for the master random number generator
                                                          • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          Input Files
                                                          
\ No newline at end of file
+
                                                          Close
                                                          \ No newline at end of file diff --git a/source/constraints/ArbitrarilyTiedValueConstraint.html b/source/constraints/ArbitrarilyTiedValueConstraint.html index 913445df42f..5ccf74c57b9 100644 --- a/source/constraints/ArbitrarilyTiedValueConstraint.html +++ b/source/constraints/ArbitrarilyTiedValueConstraint.html @@ -1,4 +1,4 @@ -ArbitrarilyTiedValueConstraint|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          ArbitrarilyTiedValueConstraint

                                                          under construction:Undocumented Class

                                                          The ArbitrarilyTiedValueConstraint has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+ArbitrarilyTiedValueConstraint|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          ArbitrarilyTiedValueConstraint
                                                          under construction:Undocumented Class
                                                          The ArbitrarilyTiedValueConstraint has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # ArbitrarilyTiedValueConstraint
 
 !syntax description /Constraints/ArbitrarilyTiedValueConstraint
@@ -18,4 +18,4 @@
 !syntax children /Constraints/ArbitrarilyTiedValueConstraint
 
                                                          
 
-!syntax description /Constraints/ArbitrarilyTiedValueConstraint
                                                          Input Parameters
                                                          • variableThe name of the variable that this constraint is applied to.
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this constraint is applied to.
                                                          • HThe value of u_slave/u_master.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The value of u_slave/u_master.
                                                          • master_variableThe variable on the master side of the domain
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The variable on the master side of the domain
                                                          • slaveThe boundary ID associated with the slave side
                                                            C++ Type:BoundaryName
                                                            Options:
                                                            Description:The boundary ID associated with the slave side
                                                          • masterThe boundary ID associated with the master side
                                                            C++ Type:BoundaryName
                                                            Options:
                                                            Description:The boundary ID associated with the master side
                                                          Required Parameters
                                                          • tangential_toleranceTangential distance to extend edges of contact surfaces
                                                            C++ Type:double
                                                            Options:
                                                            Description:Tangential distance to extend edges of contact surfaces
                                                          • normal_smoothing_distanceDistance from edge in parametric coordinates over which to smooth contact normal
                                                            C++ Type:double
                                                            Options:
                                                            Description:Distance from edge in parametric coordinates over which to smooth contact normal
                                                          • scaling1scaling factor to be applied to constraint equations
                                                            Default:1
                                                            C++ Type:double
                                                            Options:
                                                            Description:scaling factor to be applied to constraint equations
                                                          • normal_smoothing_methodMethod to use to smooth normals (edge_based|nodal_normal_based)
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:Method to use to smooth normals (edge_based|nodal_normal_based)
                                                          • execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                            Default:LINEAR
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                          • orderFIRSTThe finite element order used for projections
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:FIRST SECOND THIRD FOURTH
                                                            Description:The finite element order used for projections
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • use_displaced_meshTrueWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          
\ No newline at end of file
+!syntax description /Constraints/ArbitrarilyTiedValueConstraint
                                                          Input Parameters
                                                          • variableThe name of the variable that this constraint is applied to.
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this constraint is applied to.
                                                          • HThe value of u_slave/u_master.
                                                            C++ Type:double
                                                            Options:
                                                            Description:The value of u_slave/u_master.
                                                          • master_variableThe variable on the master side of the domain
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The variable on the master side of the domain
                                                          • slaveThe boundary ID associated with the slave side
                                                            C++ Type:BoundaryName
                                                            Options:
                                                            Description:The boundary ID associated with the slave side
                                                          • masterThe boundary ID associated with the master side
                                                            C++ Type:BoundaryName
                                                            Options:
                                                            Description:The boundary ID associated with the master side
                                                          Required Parameters
                                                          • tangential_toleranceTangential distance to extend edges of contact surfaces
                                                            C++ Type:double
                                                            Options:
                                                            Description:Tangential distance to extend edges of contact surfaces
                                                          • normal_smoothing_distanceDistance from edge in parametric coordinates over which to smooth contact normal
                                                            C++ Type:double
                                                            Options:
                                                            Description:Distance from edge in parametric coordinates over which to smooth contact normal
                                                          • scaling1scaling factor to be applied to constraint equations
                                                            Default:1
                                                            C++ Type:double
                                                            Options:
                                                            Description:scaling factor to be applied to constraint equations
                                                          • normal_smoothing_methodMethod to use to smooth normals (edge_based|nodal_normal_based)
                                                            C++ Type:std::string
                                                            Options:
                                                            Description:Method to use to smooth normals (edge_based|nodal_normal_based)
                                                          • execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                            Default:LINEAR
                                                            C++ Type:ExecFlagEnum
                                                            Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM
                                                            Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                          • orderFIRSTThe finite element order used for projections
                                                            Default:FIRST
                                                            C++ Type:MooseEnum
                                                            Options:FIRST SECOND THIRD FOURTH
                                                            Description:The finite element order used for projections
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • use_displaced_meshTrueWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          \ No newline at end of file diff --git a/source/dgkernels/DGCoeffDiffusion.html b/source/dgkernels/DGCoeffDiffusion.html index 0f83adcc0f1..e82c635e9fd 100644 --- a/source/dgkernels/DGCoeffDiffusion.html +++ b/source/dgkernels/DGCoeffDiffusion.html @@ -1,4 +1,4 @@ -DGCoeffDiffusion|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DGCoeffDiffusion

                                                          under construction:Undocumented Class

                                                          The DGCoeffDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DGCoeffDiffusion|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DGCoeffDiffusion
                                                          under construction:Undocumented Class
                                                          The DGCoeffDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DGCoeffDiffusion
 
 !syntax description /DGKernels/DGCoeffDiffusion
@@ -18,4 +18,4 @@
 !syntax children /DGKernels/DGCoeffDiffusion
 
                                                          
 
-!syntax description /DGKernels/DGCoeffDiffusion
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • epsilonepsilon
                                                            C++ Type:double
                                                            Options:
                                                            Description:epsilon
                                                          • sigmasigma
                                                            C++ Type:double
                                                            Options:
                                                            Description:sigma
                                                          Required Parameters
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          
\ No newline at end of file
+!syntax description /DGKernels/DGCoeffDiffusion
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • epsilonepsilon
                                                            C++ Type:double
                                                            Options:
                                                            Description:epsilon
                                                          • sigmasigma
                                                            C++ Type:double
                                                            Options:
                                                            Description:sigma
                                                          Required Parameters
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          \ No newline at end of file diff --git a/source/dgkernels/DGEFieldAdvection.html b/source/dgkernels/DGEFieldAdvection.html index 507d636ed90..8eee2e24c50 100644 --- a/source/dgkernels/DGEFieldAdvection.html +++ b/source/dgkernels/DGEFieldAdvection.html @@ -1,4 +1,4 @@ -DGEFieldAdvection|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          DGEFieldAdvection

                                                          under construction:Undocumented Class

                                                          The DGEFieldAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                          
+DGEFieldAdvection|Zapdos
                                                          Code Documentation
                                                          Application Development
                                                          Questions and General Information
                                                          Developer Information (from MOOSE website)
                                                          DGEFieldAdvection
                                                          under construction:Undocumented Class
                                                          The DGEFieldAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                          
 # DGEFieldAdvection
 
 !syntax description /DGKernels/DGEFieldAdvection
@@ -18,4 +18,4 @@
 !syntax children /DGKernels/DGEFieldAdvection
 
                                                          
 
-!syntax description /DGKernels/DGEFieldAdvection
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • potentialThe potential that drives advection.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential that drives advection.
                                                          Required Parameters
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          
\ No newline at end of file
+!syntax description /DGKernels/DGEFieldAdvection
                                                          Input Parameters
                                                          • variableThe name of the variable that this boundary condition applies to
                                                            C++ Type:NonlinearVariableName
                                                            Options:
                                                            Description:The name of the variable that this boundary condition applies to
                                                          • potentialThe potential that drives advection.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The potential that drives advection.
                                                          Required Parameters
                                                          • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                          • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          • blockThe list of block ids (SubdomainID) that this object will be applied
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The list of block ids (SubdomainID) that this object will be applied
                                                          • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                          Optional Parameters
                                                          • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:Adds user-defined labels for accessing object parameters via control logic.
                                                          • enableTrueSet the enabled status of the MooseObject.
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Set the enabled status of the MooseObject.
                                                          • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                            Default:True
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Determines whether this object is calculated using an implicit or explicit form
                                                          • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                            Default:False
                                                            C++ Type:bool
                                                            Options:
                                                            Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                          Advanced Parameters
                                                          • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                            Default:nontime
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime time
                                                            Description:The tag for the vectors this Kernel should fill
                                                          • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the vectors this Kernel should fill
                                                          • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                            Default:system
                                                            C++ Type:MultiMooseEnum
                                                            Options:nontime system
                                                            Description:The tag for the matrices this Kernel should fill
                                                          • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                            C++ Type:std::vector
                                                            Options:
                                                            Description:The extra tags for the matrices this Kernel should fill
                                                          Tagging Parameters
                                                          \ No newline at end of file diff --git a/source/index.html b/source/index.html index f3f95531608..ab26215d9ea 100644 --- a/source/index.html +++ b/source/index.html @@ -1 +1 @@ -Source Documentation|Zapdos

                                                          Code Documentation

                                                          Application Development

                                                          Questions and General Information

                                                          Developer Information (from MOOSE website)

                                                          Source Documentation

                                                          The following is a complete list of documented Zapdos C++ source. Please see the MOOSE Source Documentation page for MOOSE C++ source.

                                                              actions

                                                              auxkernels

                                                              bcs

                                                              constraints

                                                                  dgkernels

                                                                    indicators

                                                                        interfacekernels

                                                                        kernels

                                                                        materials

                                                                        meshmodifiers

                                                                            postprocessors

                                                                              userobjects

                                                                              \ No newline at end of file +Source Documentation|Zapdos

                                                                              Code Documentation

                                                                              Application Development

                                                                              Questions and General Information

                                                                              Developer Information (from MOOSE website)

                                                                              Source Documentation

                                                                              The following is a complete list of documented Zapdos C++ source. Please see the MOOSE Source Documentation page for MOOSE C++ source.

                                                                                  actions

                                                                                  auxkernels

                                                                                  bcs

                                                                                  constraints

                                                                                      dgkernels

                                                                                        indicators

                                                                                            interfacekernels

                                                                                            kernels

                                                                                            materials

                                                                                            meshmodifiers

                                                                                                postprocessors

                                                                                                  userobjects

                                                                                                  \ No newline at end of file diff --git a/source/indicators/AnalyticalDiffIndicator.html b/source/indicators/AnalyticalDiffIndicator.html index 3798b132928..8e8c8d46f82 100644 --- a/source/indicators/AnalyticalDiffIndicator.html +++ b/source/indicators/AnalyticalDiffIndicator.html @@ -1,4 +1,4 @@ -AnalyticalDiffIndicator|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  AnalyticalDiffIndicator

                                                                                                  under construction:Undocumented Class

                                                                                                  The AnalyticalDiffIndicator has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+AnalyticalDiffIndicator|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  AnalyticalDiffIndicator
                                                                                                  under construction:Undocumented Class
                                                                                                  The AnalyticalDiffIndicator has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # AnalyticalDiffIndicator
 
 !syntax description /Adaptivity/Indicators/AnalyticalDiffIndicator
@@ -18,4 +18,4 @@
 !syntax children /Adaptivity/Indicators/AnalyticalDiffIndicator
 
                                                                                                  
 
-!syntax description /Adaptivity/Indicators/AnalyticalDiffIndicator
                                                                                                  Input Parameters
                                                                                                  • functionThe analytic solution to compare against
                                                                                                    C++ Type:FunctionName
                                                                                                    Options:
                                                                                                    Description:The analytic solution to compare against
                                                                                                  • variableThe name of the variable that this Indicator operates on
                                                                                                    C++ Type:VariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Indicator operates on
                                                                                                  Required Parameters
                                                                                                  • blockANY_BLOCK_ID block ID or name where the object works
                                                                                                    Default:ANY_BLOCK_ID 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:block ID or name where the object works
                                                                                                  Optional Parameters
                                                                                                  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Adaptivity/Indicators/AnalyticalDiffIndicator
                                                                                                  Input Parameters
                                                                                                  • functionThe analytic solution to compare against
                                                                                                    C++ Type:FunctionName
                                                                                                    Options:
                                                                                                    Description:The analytic solution to compare against
                                                                                                  • variableThe name of the variable that this Indicator operates on
                                                                                                    C++ Type:VariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Indicator operates on
                                                                                                  Required Parameters
                                                                                                  • blockANY_BLOCK_ID block ID or name where the object works
                                                                                                    Default:ANY_BLOCK_ID 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:block ID or name where the object works
                                                                                                  Optional Parameters
                                                                                                  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  \ No newline at end of file diff --git a/source/interfacekernels/HphiRadialInterface.html b/source/interfacekernels/HphiRadialInterface.html index 6d0e701aeed..aec1622d903 100644 --- a/source/interfacekernels/HphiRadialInterface.html +++ b/source/interfacekernels/HphiRadialInterface.html @@ -1,4 +1,4 @@ -HphiRadialInterface|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  HphiRadialInterface

                                                                                                  under construction:Undocumented Class

                                                                                                  The HphiRadialInterface has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+HphiRadialInterface|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  HphiRadialInterface
                                                                                                  under construction:Undocumented Class
                                                                                                  The HphiRadialInterface has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # HphiRadialInterface
 
 !syntax description /InterfaceKernels/HphiRadialInterface
@@ -18,26 +18,25 @@
 !syntax children /InterfaceKernels/HphiRadialInterface
 
                                                                                                  
 
-!syntax description /InterfaceKernels/HphiRadialInterface
                                                                                                  Input Parameters
                                                                                                  • neighbor_varThe variable on the other side of the interface.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The variable on the other side of the interface.
                                                                                                  • variableThe name of the variable that this boundary condition applies to
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this boundary condition applies to
                                                                                                  Required Parameters
                                                                                                  • save_in_var_sideThis parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the master ('m') or slave side ('s').
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:m s
                                                                                                    Description:This parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the master ('m') or slave side ('s').
                                                                                                  • diag_save_in_var_sideThis parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the master ('m') or slave side ('s').
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:m s
                                                                                                    Description:This parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the master ('m') or slave side ('s').
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  Optional Parameters
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/interfacekernels/InterfaceAdvection.html b/source/interfacekernels/InterfaceAdvection.html index a8948738091..3bd6b37c677 100644 --- a/source/interfacekernels/InterfaceAdvection.html +++ b/source/interfacekernels/InterfaceAdvection.html @@ -1,4 +1,4 @@ -InterfaceAdvection|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  InterfaceAdvection

                                                                                                  under construction:Undocumented Class

                                                                                                  The InterfaceAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+InterfaceAdvection|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  InterfaceAdvection
                                                                                                  under construction:Undocumented Class
                                                                                                  The InterfaceAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # InterfaceAdvection
 
 !syntax description /InterfaceKernels/InterfaceAdvection
@@ -18,7 +18,7 @@
 !syntax children /InterfaceKernels/InterfaceAdvection
 
                                                                                                  
 
-!syntax description /InterfaceKernels/InterfaceAdvection
                                                                                                  Input Parameters
                                                                                                  • neighbor_varThe variable on the other side of the interface.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The variable on the other side of the interface.
                                                                                                  • neighbor_position_unitsThe units of position in the neighboring domain.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The units of position in the neighboring domain.
                                                                                                  • mean_en_neighborThe log of the product of the mean energy and electron density on the slave side of the interface.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the product of the mean energy and electron density on the slave side of the interface.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this boundary condition applies to
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this boundary condition applies to
                                                                                                  • potential_neighborThe potential on the slave side of the interface.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential on the slave side of the interface.
                                                                                                  Required Parameters
                                                                                                  • save_in_var_sideThis parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the master ('m') or slave side ('s').
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:m s
                                                                                                    Description:This parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the master ('m') or slave side ('s').
                                                                                                  • diag_save_in_var_sideThis parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the master ('m') or slave side ('s').
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:m s
                                                                                                    Description:This parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the master ('m') or slave side ('s').
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  Optional Parameters
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/interfacekernels/InterfaceLogDiffusionElectrons.html b/source/interfacekernels/InterfaceLogDiffusionElectrons.html index abd18957f53..30df80dd045 100644 --- a/source/interfacekernels/InterfaceLogDiffusionElectrons.html +++ b/source/interfacekernels/InterfaceLogDiffusionElectrons.html @@ -1,4 +1,4 @@ -InterfaceLogDiffusionElectrons|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  InterfaceLogDiffusionElectrons

                                                                                                  under construction:Undocumented Class

                                                                                                  The InterfaceLogDiffusionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+InterfaceLogDiffusionElectrons|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  InterfaceLogDiffusionElectrons
                                                                                                  under construction:Undocumented Class
                                                                                                  The InterfaceLogDiffusionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # InterfaceLogDiffusionElectrons
 
 !syntax description /InterfaceKernels/InterfaceLogDiffusionElectrons
@@ -18,7 +18,7 @@
 !syntax children /InterfaceKernels/InterfaceLogDiffusionElectrons
 
                                                                                                  
 
-!syntax description /InterfaceKernels/InterfaceLogDiffusionElectrons
                                                                                                  Input Parameters
                                                                                                  • neighbor_varThe variable on the other side of the interface.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The variable on the other side of the interface.
                                                                                                  • mean_en_neighborThe log of the product of the mean energy and electron density on the slave side of the interface.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the product of the mean energy and electron density on the slave side of the interface.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this boundary condition applies to
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this boundary condition applies to
                                                                                                  • neighbor_position_unitsThe units of position in the neighboring domain.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The units of position in the neighboring domain.
                                                                                                  Required Parameters
                                                                                                  • save_in_var_sideThis parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the master ('m') or slave side ('s').
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:m s
                                                                                                    Description:This parameter must exist if save_in variables are specified and must have the same length as save_in. This vector specifies whether the corresponding aux_var should save-in residual contributions from the master ('m') or slave side ('s').
                                                                                                  • diag_save_in_var_sideThis parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the master ('m') or slave side ('s').
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:m s
                                                                                                    Description:This parameter must exist if diag_save_in variables are specified and must have the same length as diag_save_in. This vector specifies whether the corresponding aux_var should save-in jacobian contributions from the master ('m') or slave side ('s').
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  Optional Parameters
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/AxisymmetricCurlZ.html b/source/kernels/AxisymmetricCurlZ.html index 76e097f0a2d..5404747af4b 100644 --- a/source/kernels/AxisymmetricCurlZ.html +++ b/source/kernels/AxisymmetricCurlZ.html @@ -1,4 +1,4 @@ -AxisymmetricCurlZ|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  AxisymmetricCurlZ

                                                                                                  under construction:Undocumented Class

                                                                                                  The AxisymmetricCurlZ has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+AxisymmetricCurlZ|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  AxisymmetricCurlZ
                                                                                                  under construction:Undocumented Class
                                                                                                  The AxisymmetricCurlZ has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # AxisymmetricCurlZ
 
 !syntax description /Kernels/AxisymmetricCurlZ
@@ -18,7 +18,7 @@
 !syntax children /Kernels/AxisymmetricCurlZ
 
                                                                                                  
 
-!syntax description /Kernels/AxisymmetricCurlZ
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ChargeSourceMoles_KV.html b/source/kernels/ChargeSourceMoles_KV.html index fb37c062e72..3b75eb845fc 100644 --- a/source/kernels/ChargeSourceMoles_KV.html +++ b/source/kernels/ChargeSourceMoles_KV.html @@ -1,4 +1,4 @@ -ChargeSourceMoles KV|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ChargeSourceMoles_KV

                                                                                                  under construction:Undocumented Class

                                                                                                  The ChargeSourceMoles_KV has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ChargeSourceMoles KV|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ChargeSourceMoles_KV
                                                                                                  under construction:Undocumented Class
                                                                                                  The ChargeSourceMoles_KV has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ChargeSourceMoles_KV
 
 !syntax description /Kernels/ChargeSourceMoles_KV
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ChargeSourceMoles_KV
 
                                                                                                  
 
-!syntax description /Kernels/ChargeSourceMoles_KV
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potential_unitsThe potential units.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The potential units.
                                                                                                  • chargedThe charged species
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The charged species
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/CoeffDiffusion.html b/source/kernels/CoeffDiffusion.html index 0ca1bc5bee2..2cdd06fbd51 100644 --- a/source/kernels/CoeffDiffusion.html +++ b/source/kernels/CoeffDiffusion.html @@ -1,4 +1,4 @@ -CoeffDiffusion|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  CoeffDiffusion

                                                                                                  under construction:Undocumented Class

                                                                                                  The CoeffDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+CoeffDiffusion|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  CoeffDiffusion
                                                                                                  under construction:Undocumented Class
                                                                                                  The CoeffDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # CoeffDiffusion
 
 !syntax description /Kernels/CoeffDiffusion
@@ -16,7 +16,7 @@
 !syntax inputs /Kernels/CoeffDiffusion
 
 !syntax children /Kernels/CoeffDiffusion
-
                                                                                                  The Laplacian operator (), with the weak form of .
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  The Laplacian operator (), with the weak form of .
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  \ No newline at end of file +
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/CoeffDiffusionElectrons.html b/source/kernels/CoeffDiffusionElectrons.html index 261af996220..26a374963a5 100644 --- a/source/kernels/CoeffDiffusionElectrons.html +++ b/source/kernels/CoeffDiffusionElectrons.html @@ -1,4 +1,4 @@ -CoeffDiffusionElectrons|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  CoeffDiffusionElectrons

                                                                                                  under construction:Undocumented Class

                                                                                                  The CoeffDiffusionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+CoeffDiffusionElectrons|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  CoeffDiffusionElectrons
                                                                                                  under construction:Undocumented Class
                                                                                                  The CoeffDiffusionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # CoeffDiffusionElectrons
 
 !syntax description /Kernels/CoeffDiffusionElectrons
@@ -18,7 +18,7 @@
 !syntax children /Kernels/CoeffDiffusionElectrons
 
                                                                                                  
 
-!syntax description /Kernels/CoeffDiffusionElectrons
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • mean_enThe log of the product of mean energy times electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the product of mean energy times electron density.
                                                                                                  • position_unitsUnits of position
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/CoeffDiffusionEnergy.html b/source/kernels/CoeffDiffusionEnergy.html index abc994def63..01828b727ec 100644 --- a/source/kernels/CoeffDiffusionEnergy.html +++ b/source/kernels/CoeffDiffusionEnergy.html @@ -1,4 +1,4 @@ -CoeffDiffusionEnergy|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  CoeffDiffusionEnergy

                                                                                                  under construction:Undocumented Class

                                                                                                  The CoeffDiffusionEnergy has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+CoeffDiffusionEnergy|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  CoeffDiffusionEnergy
                                                                                                  under construction:Undocumented Class
                                                                                                  The CoeffDiffusionEnergy has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # CoeffDiffusionEnergy
 
 !syntax description /Kernels/CoeffDiffusionEnergy
@@ -18,7 +18,7 @@
 !syntax children /Kernels/CoeffDiffusionEnergy
 
                                                                                                  
 
-!syntax description /Kernels/CoeffDiffusionEnergy
                                                                                                  Input Parameters
                                                                                                  • emThe log of the electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/CoeffDiffusionLin.html b/source/kernels/CoeffDiffusionLin.html index 7459f624ccc..75e86857a0e 100644 --- a/source/kernels/CoeffDiffusionLin.html +++ b/source/kernels/CoeffDiffusionLin.html @@ -1,4 +1,4 @@ -CoeffDiffusionLin|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  CoeffDiffusionLin

                                                                                                  under construction:Undocumented Class

                                                                                                  The CoeffDiffusionLin has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+CoeffDiffusionLin|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  CoeffDiffusionLin
                                                                                                  under construction:Undocumented Class
                                                                                                  The CoeffDiffusionLin has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # CoeffDiffusionLin
 
 !syntax description /Kernels/CoeffDiffusionLin
@@ -16,7 +16,7 @@
 !syntax inputs /Kernels/CoeffDiffusionLin
 
 !syntax children /Kernels/CoeffDiffusionLin
-
                                                                                                  The Laplacian operator (), with the weak form of .
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  The Laplacian operator (), with the weak form of .
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  \ No newline at end of file +
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/DriftDiffusion.html b/source/kernels/DriftDiffusion.html index c26103782c2..7ecbf241428 100644 --- a/source/kernels/DriftDiffusion.html +++ b/source/kernels/DriftDiffusion.html @@ -1,4 +1,4 @@ -DriftDiffusion|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  DriftDiffusion

                                                                                                  under construction:Undocumented Class

                                                                                                  The DriftDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+DriftDiffusion|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  DriftDiffusion
                                                                                                  under construction:Undocumented Class
                                                                                                  The DriftDiffusion has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # DriftDiffusion
 
 !syntax description /Kernels/DriftDiffusion
@@ -18,7 +18,7 @@
 !syntax children /Kernels/DriftDiffusion
 
                                                                                                  
 
-!syntax description /Kernels/DriftDiffusion
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                  • muThe mobility.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The mobility.
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • use_material_propsTrueWhether to use a material for properties.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use a material for properties.
                                                                                                  • diffThe diffusivity.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The diffusivity.
                                                                                                  • signThe sign of the charged particle.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The sign of the charged particle.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Child Objects
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/DriftDiffusionElectrons.html b/source/kernels/DriftDiffusionElectrons.html index 1e517e431a5..9afef034bf7 100644 --- a/source/kernels/DriftDiffusionElectrons.html +++ b/source/kernels/DriftDiffusionElectrons.html @@ -1,4 +1,4 @@ -DriftDiffusionElectrons|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  DriftDiffusionElectrons

                                                                                                  under construction:Undocumented Class

                                                                                                  The DriftDiffusionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+DriftDiffusionElectrons|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  DriftDiffusionElectrons
                                                                                                  under construction:Undocumented Class
                                                                                                  The DriftDiffusionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # DriftDiffusionElectrons
 
 !syntax description /Kernels/DriftDiffusionElectrons
@@ -18,4 +18,4 @@
 !syntax children /Kernels/DriftDiffusionElectrons
 
                                                                                                  
 
-!syntax description /Kernels/DriftDiffusionElectrons
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • mean_enThe log of the product of mean energy times electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the product of mean energy times electron density.
                                                                                                  • position_unitsUnits of position
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Kernels/DriftDiffusionElectrons
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • mean_enThe log of the product of mean energy times electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the product of mean energy times electron density.
                                                                                                  • position_unitsUnits of position
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  \ No newline at end of file diff --git a/source/kernels/DriftDiffusionEnergy.html b/source/kernels/DriftDiffusionEnergy.html index be89d3c6fdd..18184dce83c 100644 --- a/source/kernels/DriftDiffusionEnergy.html +++ b/source/kernels/DriftDiffusionEnergy.html @@ -1,4 +1,4 @@ -DriftDiffusionEnergy|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  DriftDiffusionEnergy

                                                                                                  under construction:Undocumented Class

                                                                                                  The DriftDiffusionEnergy has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+DriftDiffusionEnergy|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  DriftDiffusionEnergy
                                                                                                  under construction:Undocumented Class
                                                                                                  The DriftDiffusionEnergy has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # DriftDiffusionEnergy
 
 !syntax description /Kernels/DriftDiffusionEnergy
@@ -18,4 +18,4 @@
 !syntax children /Kernels/DriftDiffusionEnergy
 
                                                                                                  
 
-!syntax description /Kernels/DriftDiffusionEnergy
                                                                                                  Input Parameters
                                                                                                  • emThe log of the electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Kernels/DriftDiffusionEnergy
                                                                                                  Input Parameters
                                                                                                  • emThe log of the electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  \ No newline at end of file diff --git a/source/kernels/DriftDiffusionUser.html b/source/kernels/DriftDiffusionUser.html index 6a500fd964f..ab8681f95d7 100644 --- a/source/kernels/DriftDiffusionUser.html +++ b/source/kernels/DriftDiffusionUser.html @@ -1,4 +1,4 @@ -DriftDiffusionUser|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  DriftDiffusionUser

                                                                                                  under construction:Undocumented Class

                                                                                                  The DriftDiffusionUser has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+DriftDiffusionUser|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  DriftDiffusionUser
                                                                                                  under construction:Undocumented Class
                                                                                                  The DriftDiffusionUser has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # DriftDiffusionUser
 
 !syntax description /Kernels/DriftDiffusionUser
@@ -18,4 +18,4 @@
 !syntax children /Kernels/DriftDiffusionUser
 
                                                                                                  
 
-!syntax description /Kernels/DriftDiffusionUser
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • diffThe diffusivity.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The diffusivity.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • muThe mobility.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The mobility.
                                                                                                  • signThe charge sign of the drift-diffusing particle.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The charge sign of the drift-diffusing particle.
                                                                                                  Required Parameters
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                  • use_material_propsTrueWhether to use a material for properties.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use a material for properties.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Kernels/DriftDiffusionUser
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • diffThe diffusivity.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The diffusivity.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • muThe mobility.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The mobility.
                                                                                                  • signThe charge sign of the drift-diffusing particle.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The charge sign of the drift-diffusing particle.
                                                                                                  Required Parameters
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                  • use_material_propsTrueWhether to use a material for properties.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use a material for properties.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  \ No newline at end of file diff --git a/source/kernels/EFieldAdvection.html b/source/kernels/EFieldAdvection.html index d94861cb613..9e65d0da878 100644 --- a/source/kernels/EFieldAdvection.html +++ b/source/kernels/EFieldAdvection.html @@ -1,4 +1,4 @@ -EFieldAdvection|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  EFieldAdvection

                                                                                                  under construction:Undocumented Class

                                                                                                  The EFieldAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+EFieldAdvection|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  EFieldAdvection
                                                                                                  under construction:Undocumented Class
                                                                                                  The EFieldAdvection has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # EFieldAdvection
 
 !syntax description /Kernels/EFieldAdvection
@@ -18,7 +18,7 @@
 !syntax children /Kernels/EFieldAdvection
 
                                                                                                  
 
-!syntax description /Kernels/EFieldAdvection
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/EFieldAdvectionElectrons.html b/source/kernels/EFieldAdvectionElectrons.html index d3141d5b8ac..446c4dea604 100644 --- a/source/kernels/EFieldAdvectionElectrons.html +++ b/source/kernels/EFieldAdvectionElectrons.html @@ -1,4 +1,4 @@ -EFieldAdvectionElectrons|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  EFieldAdvectionElectrons

                                                                                                  under construction:Undocumented Class

                                                                                                  The EFieldAdvectionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+EFieldAdvectionElectrons|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  EFieldAdvectionElectrons
                                                                                                  under construction:Undocumented Class
                                                                                                  The EFieldAdvectionElectrons has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # EFieldAdvectionElectrons
 
 !syntax description /Kernels/EFieldAdvectionElectrons
@@ -18,7 +18,7 @@
 !syntax children /Kernels/EFieldAdvectionElectrons
 
                                                                                                  
 
-!syntax description /Kernels/EFieldAdvectionElectrons
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • mean_enThe log of the mean energy.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the mean energy.
                                                                                                  • position_unitsThe units of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/EFieldAdvectionEnergy.html b/source/kernels/EFieldAdvectionEnergy.html index 4be2f8a91b2..046cc7981b0 100644 --- a/source/kernels/EFieldAdvectionEnergy.html +++ b/source/kernels/EFieldAdvectionEnergy.html @@ -1,4 +1,4 @@ -EFieldAdvectionEnergy|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  EFieldAdvectionEnergy

                                                                                                  under construction:Undocumented Class

                                                                                                  The EFieldAdvectionEnergy has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+EFieldAdvectionEnergy|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  EFieldAdvectionEnergy
                                                                                                  under construction:Undocumented Class
                                                                                                  The EFieldAdvectionEnergy has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # EFieldAdvectionEnergy
 
 !syntax description /Kernels/EFieldAdvectionEnergy
@@ -18,7 +18,7 @@
 !syntax children /Kernels/EFieldAdvectionEnergy
 
                                                                                                  
 
-!syntax description /Kernels/EFieldAdvectionEnergy
                                                                                                  Input Parameters
                                                                                                  • emThe log of the electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The log of the electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • position_unitsUnits of position
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/EFieldArtDiff.html b/source/kernels/EFieldArtDiff.html index 1f7d99441e0..f5c5c6bc301 100644 --- a/source/kernels/EFieldArtDiff.html +++ b/source/kernels/EFieldArtDiff.html @@ -1,4 +1,4 @@ -EFieldArtDiff|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  EFieldArtDiff

                                                                                                  under construction:Undocumented Class

                                                                                                  The EFieldArtDiff has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+EFieldArtDiff|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  EFieldArtDiff
                                                                                                  under construction:Undocumented Class
                                                                                                  The EFieldArtDiff has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # EFieldArtDiff
 
 !syntax description /Kernels/EFieldArtDiff
@@ -18,7 +18,7 @@
 !syntax children /Kernels/EFieldArtDiff
 
                                                                                                  
 
-!syntax description /Kernels/EFieldArtDiff
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe potential for calculating the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential for calculating the advection velocity.
                                                                                                  • position_unitsUnits of position
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position
                                                                                                  Required Parameters
                                                                                                  • scale1Amount to scale artificial diffusion.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Amount to scale artificial diffusion.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/EFieldMagnitudeSource.html b/source/kernels/EFieldMagnitudeSource.html index 90f16be229b..525ac8cb503 100644 --- a/source/kernels/EFieldMagnitudeSource.html +++ b/source/kernels/EFieldMagnitudeSource.html @@ -1,4 +1,4 @@ -EFieldMagnitudeSource|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  EFieldMagnitudeSource

                                                                                                  under construction:Undocumented Class

                                                                                                  The EFieldMagnitudeSource has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+EFieldMagnitudeSource|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  EFieldMagnitudeSource
                                                                                                  under construction:Undocumented Class
                                                                                                  The EFieldMagnitudeSource has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # EFieldMagnitudeSource
 
 !syntax description /Kernels/EFieldMagnitudeSource
@@ -18,4 +18,4 @@
 !syntax children /Kernels/EFieldMagnitudeSource
 
                                                                                                  
 
-!syntax description /Kernels/EFieldMagnitudeSource
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe electric potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electric potential.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Kernels/EFieldMagnitudeSource
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe electric potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electric potential.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronEnergyLossFromElastic.html b/source/kernels/ElectronEnergyLossFromElastic.html index 9fabeb82e6d..b2051282182 100644 --- a/source/kernels/ElectronEnergyLossFromElastic.html +++ b/source/kernels/ElectronEnergyLossFromElastic.html @@ -1,4 +1,4 @@ -ElectronEnergyLossFromElastic|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronEnergyLossFromElastic

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronEnergyLossFromElastic has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronEnergyLossFromElastic|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronEnergyLossFromElastic
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronEnergyLossFromElastic has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronEnergyLossFromElastic
 
 !syntax description /Kernels/ElectronEnergyLossFromElastic
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ElectronEnergyLossFromElastic
 
                                                                                                  
 
-!syntax description /Kernels/ElectronEnergyLossFromElastic
                                                                                                  Input Parameters
                                                                                                  • emThe electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronEnergyLossFromExcitation.html b/source/kernels/ElectronEnergyLossFromExcitation.html index d0b92c8b21c..6459f1252da 100644 --- a/source/kernels/ElectronEnergyLossFromExcitation.html +++ b/source/kernels/ElectronEnergyLossFromExcitation.html @@ -1,4 +1,4 @@ -ElectronEnergyLossFromExcitation|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronEnergyLossFromExcitation

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronEnergyLossFromExcitation has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronEnergyLossFromExcitation|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronEnergyLossFromExcitation
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronEnergyLossFromExcitation has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronEnergyLossFromExcitation
 
 !syntax description /Kernels/ElectronEnergyLossFromExcitation
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ElectronEnergyLossFromExcitation
 
                                                                                                  
 
-!syntax description /Kernels/ElectronEnergyLossFromExcitation
                                                                                                  Input Parameters
                                                                                                  • emThe electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronEnergyLossFromIonization.html b/source/kernels/ElectronEnergyLossFromIonization.html index d620f57afa9..3a6c8d5996c 100644 --- a/source/kernels/ElectronEnergyLossFromIonization.html +++ b/source/kernels/ElectronEnergyLossFromIonization.html @@ -1,4 +1,4 @@ -ElectronEnergyLossFromIonization|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronEnergyLossFromIonization

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronEnergyLossFromIonization has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronEnergyLossFromIonization|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronEnergyLossFromIonization
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronEnergyLossFromIonization has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronEnergyLossFromIonization
 
 !syntax description /Kernels/ElectronEnergyLossFromIonization
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ElectronEnergyLossFromIonization
 
                                                                                                  
 
-!syntax description /Kernels/ElectronEnergyLossFromIonization
                                                                                                  Input Parameters
                                                                                                  • emThe electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronEnergyTermElasticRate.html b/source/kernels/ElectronEnergyTermElasticRate.html index 6c1c1194b19..a4bc55afb1f 100644 --- a/source/kernels/ElectronEnergyTermElasticRate.html +++ b/source/kernels/ElectronEnergyTermElasticRate.html @@ -1,4 +1,4 @@ -ElectronEnergyTermElasticRate|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronEnergyTermElasticRate

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronEnergyTermElasticRate has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronEnergyTermElasticRate|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronEnergyTermElasticRate
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronEnergyTermElasticRate has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronEnergyTermElasticRate
 
 !syntax description /Kernels/ElectronEnergyTermElasticRate
@@ -18,4 +18,4 @@
 !syntax children /Kernels/ElectronEnergyTermElasticRate
 
                                                                                                  
 
-!syntax description /Kernels/ElectronEnergyTermElasticRate
                                                                                                  Input Parameters
                                                                                                  • reactionThe reaction that is adding/removing energy.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The reaction that is adding/removing energy.
                                                                                                  • target_speciesThe target species in this elasic reaction.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The target species in this elasic reaction.
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • electron_speciesThe impacting (electron) species.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The impacting (electron) species.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Kernels/ElectronEnergyTermElasticRate
                                                                                                  Input Parameters
                                                                                                  • reactionThe reaction that is adding/removing energy.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The reaction that is adding/removing energy.
                                                                                                  • target_speciesThe target species in this elasic reaction.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The target species in this elasic reaction.
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • electron_speciesThe impacting (electron) species.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The impacting (electron) species.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronEnergyTermRate.html b/source/kernels/ElectronEnergyTermRate.html index c60792dcbfe..f8b10e804ad 100644 --- a/source/kernels/ElectronEnergyTermRate.html +++ b/source/kernels/ElectronEnergyTermRate.html @@ -1,4 +1,4 @@ -ElectronEnergyTermRate|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronEnergyTermRate

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronEnergyTermRate has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronEnergyTermRate|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronEnergyTermRate
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronEnergyTermRate has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronEnergyTermRate
 
 !syntax description /Kernels/ElectronEnergyTermRate
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ElectronEnergyTermRate
 
                                                                                                  
 
-!syntax description /Kernels/ElectronEnergyTermRate
                                                                                                  Input Parameters
                                                                                                  • emThe electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density.
                                                                                                  • reactionThe reaction that is adding/removing energy.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The reaction that is adding/removing energy.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • threshold_energy0Energy required for reaction to take place.
                                                                                                    Default:0
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Energy required for reaction to take place.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • elastic_collisionFalseIf the collision is elastic.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:If the collision is elastic.
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • vThe second reactant species.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The second reactant species.
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronTimeDerivative.html b/source/kernels/ElectronTimeDerivative.html index 6f07c60fdc6..24da619c5d6 100644 --- a/source/kernels/ElectronTimeDerivative.html +++ b/source/kernels/ElectronTimeDerivative.html @@ -1,4 +1,4 @@ -ElectronTimeDerivative|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronTimeDerivative

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronTimeDerivative has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronTimeDerivative|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronTimeDerivative
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronTimeDerivative has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronTimeDerivative
 
 !syntax description /Kernels/ElectronTimeDerivative
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ElectronTimeDerivative
 
                                                                                                  
 
-!syntax description /Kernels/ElectronTimeDerivative
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  Required Parameters
                                                                                                  • lumpingFalseTrue for mass matrix lumping, false otherwise
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:True for mass matrix lumping, false otherwise
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagstimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:time
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystem timeThe tag for the matrices this Kernel should fill
                                                                                                    Default:system time
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system time
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronsFromIonization.html b/source/kernels/ElectronsFromIonization.html index b1812463fce..ede637a6162 100644 --- a/source/kernels/ElectronsFromIonization.html +++ b/source/kernels/ElectronsFromIonization.html @@ -1,4 +1,4 @@ -ElectronsFromIonization|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronsFromIonization

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronsFromIonization has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronsFromIonization|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronsFromIonization
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronsFromIonization has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronsFromIonization
 
 !syntax description /Kernels/ElectronsFromIonization
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ElectronsFromIonization
 
                                                                                                  
 
-!syntax description /Kernels/ElectronsFromIonization
                                                                                                  Input Parameters
                                                                                                  • emThe electron density in logarithmic form.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density in logarithmic form.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • mean_en3.0The electron mean energy.
                                                                                                    Default:3.0
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy.
                                                                                                  • alpha_izThe Townsend ionization coefficient.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The Townsend ionization coefficient.
                                                                                                  • diffemThe diffusivity.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The diffusivity.
                                                                                                  • muemThe mobility.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The mobility.
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • use_material_propsTrueWhether to use a material for properties.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use a material for properties.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ElectronsFromIonizationUser.html b/source/kernels/ElectronsFromIonizationUser.html index 91dd7e62403..8679442275c 100644 --- a/source/kernels/ElectronsFromIonizationUser.html +++ b/source/kernels/ElectronsFromIonizationUser.html @@ -1,4 +1,4 @@ -ElectronsFromIonizationUser|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ElectronsFromIonizationUser

                                                                                                  under construction:Undocumented Class

                                                                                                  The ElectronsFromIonizationUser has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ElectronsFromIonizationUser|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ElectronsFromIonizationUser
                                                                                                  under construction:Undocumented Class
                                                                                                  The ElectronsFromIonizationUser has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ElectronsFromIonizationUser
 
 !syntax description /Kernels/ElectronsFromIonizationUser
@@ -18,4 +18,4 @@
 !syntax children /Kernels/ElectronsFromIonizationUser
 
                                                                                                  
 
-!syntax description /Kernels/ElectronsFromIonizationUser
                                                                                                  Input Parameters
                                                                                                  • emThe electron density in logarithmic form.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density in logarithmic form.
                                                                                                  • alpha_izThe Townsend ionization coefficient.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The Townsend ionization coefficient.
                                                                                                  • muemThe mobility.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The mobility.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • diffemThe diffusivity.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The diffusivity.
                                                                                                  Required Parameters
                                                                                                  • mean_en3.0The electron mean energy.
                                                                                                    Default:3.0
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • use_material_propsTrueWhether to use a material for properties.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use a material for properties.
                                                                                                  • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Kernels/ElectronsFromIonizationUser
                                                                                                  Input Parameters
                                                                                                  • emThe electron density in logarithmic form.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density in logarithmic form.
                                                                                                  • alpha_izThe Townsend ionization coefficient.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The Townsend ionization coefficient.
                                                                                                  • muemThe mobility.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The mobility.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • diffemThe diffusivity.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The diffusivity.
                                                                                                  Required Parameters
                                                                                                  • mean_en3.0The electron mean energy.
                                                                                                    Default:3.0
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy.
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • use_material_propsTrueWhether to use a material for properties.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use a material for properties.
                                                                                                  • EFieldOptionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Optionally can use a specified electric field for 1D simulations in place of a potential variable
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ExcitationReaction.html b/source/kernels/ExcitationReaction.html index f402bd37fe4..72085cff708 100644 --- a/source/kernels/ExcitationReaction.html +++ b/source/kernels/ExcitationReaction.html @@ -1,4 +1,4 @@ -ExcitationReaction|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ExcitationReaction

                                                                                                  under construction:Undocumented Class

                                                                                                  The ExcitationReaction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ExcitationReaction|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ExcitationReaction
                                                                                                  under construction:Undocumented Class
                                                                                                  The ExcitationReaction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ExcitationReaction
 
 !syntax description /Kernels/ExcitationReaction
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ExcitationReaction
 
                                                                                                  
 
-!syntax description /Kernels/ExcitationReaction
                                                                                                  Input Parameters
                                                                                                  • emThe electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density.
                                                                                                  • reactantFalseChecks if the variable is the reactant.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Checks if the variable is the reactant.
                                                                                                  • mean_enThe electron mean energy.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy.
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/IonsFromIonization.html b/source/kernels/IonsFromIonization.html index b4a68bef8af..889f6924678 100644 --- a/source/kernels/IonsFromIonization.html +++ b/source/kernels/IonsFromIonization.html @@ -1,4 +1,4 @@ -IonsFromIonization|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  IonsFromIonization

                                                                                                  under construction:Undocumented Class

                                                                                                  The IonsFromIonization has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+IonsFromIonization|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  IonsFromIonization
                                                                                                  under construction:Undocumented Class
                                                                                                  The IonsFromIonization has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # IonsFromIonization
 
 !syntax description /Kernels/IonsFromIonization
@@ -18,7 +18,7 @@
 !syntax children /Kernels/IonsFromIonization
 
                                                                                                  
 
-!syntax description /Kernels/IonsFromIonization
                                                                                                  Input Parameters
                                                                                                  • emThe electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • mean_enThe electron mean energy.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/JouleHeating.html b/source/kernels/JouleHeating.html index 50213825582..7f80cd814dd 100644 --- a/source/kernels/JouleHeating.html +++ b/source/kernels/JouleHeating.html @@ -1,4 +1,4 @@ -JouleHeating|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  JouleHeating

                                                                                                  under construction:Undocumented Class

                                                                                                  The JouleHeating has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+JouleHeating|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  JouleHeating
                                                                                                  under construction:Undocumented Class
                                                                                                  The JouleHeating has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # JouleHeating
 
 !syntax description /Kernels/JouleHeating
@@ -18,7 +18,7 @@
 !syntax children /Kernels/JouleHeating
 
                                                                                                  
 
-!syntax description /Kernels/JouleHeating
                                                                                                  Input Parameters
                                                                                                  • emThe electron density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron density.
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe gradient of the potential will be used to compute the advection velocity.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gradient of the potential will be used to compute the advection velocity.
                                                                                                  • potential_unitsThe potential units.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The potential units.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/LogStabilizationMoles.html b/source/kernels/LogStabilizationMoles.html index bf4407fd7e3..e720535e780 100644 --- a/source/kernels/LogStabilizationMoles.html +++ b/source/kernels/LogStabilizationMoles.html @@ -1,4 +1,4 @@ -LogStabilizationMoles|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  LogStabilizationMoles

                                                                                                  under construction:Undocumented Class

                                                                                                  The LogStabilizationMoles has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+LogStabilizationMoles|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  LogStabilizationMoles
                                                                                                  under construction:Undocumented Class
                                                                                                  The LogStabilizationMoles has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # LogStabilizationMoles
 
 !syntax description /Kernels/LogStabilizationMoles
@@ -18,7 +18,7 @@
 !syntax children /Kernels/LogStabilizationMoles
 
                                                                                                  
 
-!syntax description /Kernels/LogStabilizationMoles
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • offsetThe offset parameter that goes into the exponential function
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The offset parameter that goes into the exponential function
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/PotentialGradientSource.html b/source/kernels/PotentialGradientSource.html index 075ac67676f..35fc9ae7b69 100644 --- a/source/kernels/PotentialGradientSource.html +++ b/source/kernels/PotentialGradientSource.html @@ -1,4 +1,4 @@ -PotentialGradientSource|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  PotentialGradientSource

                                                                                                  under construction:Undocumented Class

                                                                                                  The PotentialGradientSource has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+PotentialGradientSource|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  PotentialGradientSource
                                                                                                  under construction:Undocumented Class
                                                                                                  The PotentialGradientSource has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # PotentialGradientSource
 
 !syntax description /Kernels/PotentialGradientSource
@@ -18,7 +18,7 @@
 !syntax children /Kernels/PotentialGradientSource
 
                                                                                                  
 
-!syntax description /Kernels/PotentialGradientSource
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ProductAABBRxn.html b/source/kernels/ProductAABBRxn.html index f8425d80d5b..8fb99de8e35 100644 --- a/source/kernels/ProductAABBRxn.html +++ b/source/kernels/ProductAABBRxn.html @@ -1,4 +1,4 @@ -ProductAABBRxn|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ProductAABBRxn

                                                                                                  under construction:Undocumented Class

                                                                                                  The ProductAABBRxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ProductAABBRxn|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ProductAABBRxn
                                                                                                  under construction:Undocumented Class
                                                                                                  The ProductAABBRxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ProductAABBRxn
 
 !syntax description /Kernels/ProductAABBRxn
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ProductAABBRxn
 
                                                                                                  
 
-!syntax description /Kernels/ProductAABBRxn
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • vThe variable that is reacting to create u.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The variable that is reacting to create u.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ProductFirstOrderRxn.html b/source/kernels/ProductFirstOrderRxn.html index 3be35bc6d62..119efd4d0ca 100644 --- a/source/kernels/ProductFirstOrderRxn.html +++ b/source/kernels/ProductFirstOrderRxn.html @@ -1,4 +1,4 @@ -ProductFirstOrderRxn|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ProductFirstOrderRxn

                                                                                                  under construction:Undocumented Class

                                                                                                  The ProductFirstOrderRxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ProductFirstOrderRxn|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ProductFirstOrderRxn
                                                                                                  under construction:Undocumented Class
                                                                                                  The ProductFirstOrderRxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ProductFirstOrderRxn
 
 !syntax description /Kernels/ProductFirstOrderRxn
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ProductFirstOrderRxn
 
                                                                                                  
 
-!syntax description /Kernels/ProductFirstOrderRxn
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • vThe variable that is reacting to create u.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The variable that is reacting to create u.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ReactantAARxn.html b/source/kernels/ReactantAARxn.html index 6dfeabb4269..9aaccc7a9fc 100644 --- a/source/kernels/ReactantAARxn.html +++ b/source/kernels/ReactantAARxn.html @@ -1,4 +1,4 @@ -ReactantAARxn|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ReactantAARxn

                                                                                                  under construction:Undocumented Class

                                                                                                  The ReactantAARxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ReactantAARxn|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ReactantAARxn
                                                                                                  under construction:Undocumented Class
                                                                                                  The ReactantAARxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ReactantAARxn
 
 !syntax description /Kernels/ReactantAARxn
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ReactantAARxn
 
                                                                                                  
 
-!syntax description /Kernels/ReactantAARxn
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/ReactantFirstOrderRxn.html b/source/kernels/ReactantFirstOrderRxn.html index d1496c8a26c..733345cd7b8 100644 --- a/source/kernels/ReactantFirstOrderRxn.html +++ b/source/kernels/ReactantFirstOrderRxn.html @@ -1,4 +1,4 @@ -ReactantFirstOrderRxn|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ReactantFirstOrderRxn

                                                                                                  under construction:Undocumented Class

                                                                                                  The ReactantFirstOrderRxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ReactantFirstOrderRxn|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ReactantFirstOrderRxn
                                                                                                  under construction:Undocumented Class
                                                                                                  The ReactantFirstOrderRxn has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ReactantFirstOrderRxn
 
 !syntax description /Kernels/ReactantFirstOrderRxn
@@ -18,7 +18,7 @@
 !syntax children /Kernels/ReactantFirstOrderRxn
 
                                                                                                  
 
-!syntax description /Kernels/ReactantFirstOrderRxn
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/TM0Cylindrical.html b/source/kernels/TM0Cylindrical.html index 2f9dd82e56b..905f17fae30 100644 --- a/source/kernels/TM0Cylindrical.html +++ b/source/kernels/TM0Cylindrical.html @@ -1,4 +1,4 @@ -TM 0 Cylindrical|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  TM0Cylindrical

                                                                                                  under construction:Undocumented Class

                                                                                                  The TM0Cylindrical has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+TM 0 Cylindrical|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  TM0Cylindrical
                                                                                                  under construction:Undocumented Class
                                                                                                  The TM0Cylindrical has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # TM0Cylindrical
 
 !syntax description /Kernels/TM0Cylindrical
@@ -18,7 +18,7 @@
 !syntax children /Kernels/TM0Cylindrical
 
                                                                                                  
 
-!syntax description /Kernels/TM0Cylindrical
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • fThe drive frequency.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The drive frequency.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/TM0CylindricalEr.html b/source/kernels/TM0CylindricalEr.html index a20f10fc14d..f6b3b6a2280 100644 --- a/source/kernels/TM0CylindricalEr.html +++ b/source/kernels/TM0CylindricalEr.html @@ -1,4 +1,4 @@ -TM 0 CylindricalEr|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  TM0CylindricalEr

                                                                                                  under construction:Undocumented Class

                                                                                                  The TM0CylindricalEr has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+TM 0 CylindricalEr|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  TM0CylindricalEr
                                                                                                  under construction:Undocumented Class
                                                                                                  The TM0CylindricalEr has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # TM0CylindricalEr
 
 !syntax description /Kernels/TM0CylindricalEr
@@ -18,7 +18,7 @@
 !syntax children /Kernels/TM0CylindricalEr
 
                                                                                                  
 
-!syntax description /Kernels/TM0CylindricalEr
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • HphiThe phi component of the magnetic field.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The phi component of the magnetic field.
                                                                                                  • fThe drive frequency.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The drive frequency.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/TM0CylindricalEz.html b/source/kernels/TM0CylindricalEz.html index 523d55ded2e..d5921d9c6ae 100644 --- a/source/kernels/TM0CylindricalEz.html +++ b/source/kernels/TM0CylindricalEz.html @@ -1,4 +1,4 @@ -TM 0 CylindricalEz|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  TM0CylindricalEz

                                                                                                  under construction:Undocumented Class

                                                                                                  The TM0CylindricalEz has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+TM 0 CylindricalEz|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  TM0CylindricalEz
                                                                                                  under construction:Undocumented Class
                                                                                                  The TM0CylindricalEz has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # TM0CylindricalEz
 
 !syntax description /Kernels/TM0CylindricalEz
@@ -18,7 +18,7 @@
 !syntax children /Kernels/TM0CylindricalEz
 
                                                                                                  
 
-!syntax description /Kernels/TM0CylindricalEz
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • HphiThe phi component of the magnetic field.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The phi component of the magnetic field.
                                                                                                  • fThe drive frequency.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The drive frequency.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/kernels/UserSource.html b/source/kernels/UserSource.html index 5f11d3846f8..9c192c55d94 100644 --- a/source/kernels/UserSource.html +++ b/source/kernels/UserSource.html @@ -1,4 +1,4 @@ -UserSource|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  UserSource

                                                                                                  under construction:Undocumented Class

                                                                                                  The UserSource has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+UserSource|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  UserSource
                                                                                                  under construction:Undocumented Class
                                                                                                  The UserSource has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # UserSource
 
 !syntax description /Kernels/UserSource
@@ -18,7 +18,7 @@
 !syntax children /Kernels/UserSource
 
                                                                                                  
 
-!syntax description /Kernels/UserSource
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this Kernel operates on
                                                                                                    C++ Type:NonlinearVariableName
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this Kernel operates on
                                                                                                  • source_magnitudeThe numerical value of the source magnitude.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The numerical value of the source magnitude.
                                                                                                  Required Parameters
                                                                                                  • displacementsThe displacements
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The displacements
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • save_inThe name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's residual contributions to.  Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  • vector_tagsnontimeThe tag for the vectors this Kernel should fill
                                                                                                    Default:nontime
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime time
                                                                                                    Description:The tag for the vectors this Kernel should fill
                                                                                                  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the vectors this Kernel should fill
                                                                                                  • matrix_tagssystemThe tag for the matrices this Kernel should fill
                                                                                                    Default:system
                                                                                                    C++ Type:MultiMooseEnum
                                                                                                    Options:nontime system
                                                                                                    Description:The tag for the matrices this Kernel should fill
                                                                                                  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The extra tags for the matrices this Kernel should fill
                                                                                                  Tagging Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/Gas.html b/source/materials/Gas.html index 69f5f3778bf..c9d35132cf6 100644 --- a/source/materials/Gas.html +++ b/source/materials/Gas.html @@ -1,4 +1,4 @@ -Gas|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  Gas

                                                                                                  under construction:Undocumented Class

                                                                                                  The Gas has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+Gas|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  Gas
                                                                                                  under construction:Undocumented Class
                                                                                                  The Gas has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # Gas
 
 !syntax description /Materials/Gas
@@ -18,7 +18,7 @@
 !syntax children /Materials/Gas
 
                                                                                                  
 
-!syntax description /Materials/Gas
                                                                                                  Input Parameters
                                                                                                  • ramp_trans_coeffsFalseWhether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.
                                                                                                  • interp_elastic_coeffFalseWhether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.
                                                                                                  • interp_trans_coeffsFalseWhether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.
                                                                                                  • potential_unitsThe potential units.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The potential units.
                                                                                                  • property_tables_fileThe file containing interpolation tables for material properties.
                                                                                                    C++ Type:FileName
                                                                                                    Options:
                                                                                                    Description:The file containing interpolation tables for material properties.
                                                                                                  • use_molesFalseWhether to use units of moles as opposed to # of molecules.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use units of moles as opposed to # of molecules.
                                                                                                  Required Parameters
                                                                                                  • emSpecies concentration needed to calculate the poisson source
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Species concentration needed to calculate the poisson source
                                                                                                  • user_Richardson_coefficient1.20173e+06The Richardson coefficient.
                                                                                                    Default:1.20173e+06
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The Richardson coefficient.
                                                                                                  • user_T_gas300The gas temperature in Kelvin.
                                                                                                    Default:300
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The gas temperature in Kelvin.
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • user_work_function5The work function.
                                                                                                    Default:5
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The work function.
                                                                                                  • ipThe ion density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The ion density.
                                                                                                  • user_relative_permittivity1Multiplies the permittivity of free space.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Multiplies the permittivity of free space.
                                                                                                  • user_field_enhancement1The field enhancement factor.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The field enhancement factor.
                                                                                                  • user_cathode_temperature300The cathode temperature in Kelvin.
                                                                                                    Default:300
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The cathode temperature in Kelvin.
                                                                                                  • potentialThe potential for calculating the electron velocity
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential for calculating the electron velocity
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • user_p_gas101000The gas pressure in Pascals.
                                                                                                    Default:101000
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The gas pressure in Pascals.
                                                                                                  • mean_enThe electron mean energy in log form.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy in log form.
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • user_se_coeff0.15The secondary electron emission coefficient.
                                                                                                    Default:0.15
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The secondary electron emission coefficient.
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/GasBase.html b/source/materials/GasBase.html index 2e641ae1f0d..bf342896c76 100644 --- a/source/materials/GasBase.html +++ b/source/materials/GasBase.html @@ -1,4 +1,4 @@ -GasBase|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  GasBase

                                                                                                  under construction:Undocumented Class

                                                                                                  The GasBase has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+GasBase|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  GasBase
                                                                                                  under construction:Undocumented Class
                                                                                                  The GasBase has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # GasBase
 
 !syntax description /Materials/GasBase
@@ -18,7 +18,7 @@
 !syntax children /Materials/GasBase
 
                                                                                                  
 
-!syntax description /Materials/GasBase
                                                                                                  Input Parameters
                                                                                                  • ramp_trans_coeffsFalseWhether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.
                                                                                                  • interp_elastic_coeffFalseWhether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.
                                                                                                  • interp_trans_coeffsFalseWhether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.
                                                                                                  • potential_unitsThe potential units.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The potential units.
                                                                                                  • property_tables_fileThe file containing interpolation tables for material properties.
                                                                                                    C++ Type:FileName
                                                                                                    Options:
                                                                                                    Description:The file containing interpolation tables for material properties.
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • use_molesFalseWhether to use units of moles as opposed to # of molecules.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use units of moles as opposed to # of molecules.
                                                                                                  Required Parameters
                                                                                                  • emSpecies concentration needed to calculate the poisson source
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Species concentration needed to calculate the poisson source
                                                                                                  • user_Richardson_coefficient1.20173e+06The Richardson coefficient.
                                                                                                    Default:1.20173e+06
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The Richardson coefficient.
                                                                                                  • user_T_gas300The gas temperature in Kelvin.
                                                                                                    Default:300
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The gas temperature in Kelvin.
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • user_work_function5The work function.
                                                                                                    Default:5
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The work function.
                                                                                                  • ipThe ion density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The ion density.
                                                                                                  • user_relative_permittivity1Multiplies the permittivity of free space.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Multiplies the permittivity of free space.
                                                                                                  • user_field_enhancement1The field enhancement factor.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The field enhancement factor.
                                                                                                  • user_cathode_temperature300The cathode temperature in Kelvin.
                                                                                                    Default:300
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The cathode temperature in Kelvin.
                                                                                                  • potentialThe potential for calculating the electron velocity
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential for calculating the electron velocity
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • user_p_gas101000The gas pressure in Pascals.
                                                                                                    Default:101000
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The gas pressure in Pascals.
                                                                                                  • mean_enThe electron mean energy in log form.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy in log form.
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • user_se_coeff0.15The secondary electron emission coefficient.
                                                                                                    Default:0.15
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The secondary electron emission coefficient.
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/GasElectronMoments.html b/source/materials/GasElectronMoments.html index 45dd6eaa9ea..2cbc2137891 100644 --- a/source/materials/GasElectronMoments.html +++ b/source/materials/GasElectronMoments.html @@ -1,4 +1,4 @@ -GasElectronMoments|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  GasElectronMoments

                                                                                                  under construction:Undocumented Class

                                                                                                  The GasElectronMoments has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+GasElectronMoments|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  GasElectronMoments
                                                                                                  under construction:Undocumented Class
                                                                                                  The GasElectronMoments has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # GasElectronMoments
 
 !syntax description /Materials/GasElectronMoments
@@ -18,7 +18,7 @@
 !syntax children /Materials/GasElectronMoments
 
                                                                                                  
 
-!syntax description /Materials/GasElectronMoments
                                                                                                  Input Parameters
                                                                                                  • ramp_trans_coeffsFalseWhether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to ramp the non-linearity of coming from the electron energy dependence of the transport coefficients.
                                                                                                  • interp_elastic_coeffFalseWhether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to interpolate the elastic collision townsend coefficient as a function of the mean energy. If false, coeffs are constant.
                                                                                                  • interp_trans_coeffsFalseWhether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to interpolate transport coefficients as a function of the mean energy. If false, coeffs are constant.
                                                                                                  • use_molesFalseWhether to use units of moles as opposed to # of molecules.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use units of moles as opposed to # of molecules.
                                                                                                  • property_tables_fileThe file containing interpolation tables for material properties.
                                                                                                    C++ Type:FileName
                                                                                                    Options:
                                                                                                    Description:The file containing interpolation tables for material properties.
                                                                                                  • potential_unitsThe potential units.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The potential units.
                                                                                                  Required Parameters
                                                                                                  • emSpecies concentration needed to calculate the poisson source
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Species concentration needed to calculate the poisson source
                                                                                                  • user_Richardson_coefficient1.20173e+06The Richardson coefficient.
                                                                                                    Default:1.20173e+06
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The Richardson coefficient.
                                                                                                  • mean_enThe electron mean energy in log form.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron mean energy in log form.
                                                                                                  • pressure_dependent_electron_coeffFalseAre the values for the electron mobility and diffusion coefficient dependent on gas pressure
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Are the values for the electron mobility and diffusion coefficient dependent on gas pressure
                                                                                                  • user_cathode_temperature300The cathode temperature in Kelvin.
                                                                                                    Default:300
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The cathode temperature in Kelvin.
                                                                                                  • user_work_function5The work function.
                                                                                                    Default:5
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The work function.
                                                                                                  • ipThe ion density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The ion density.
                                                                                                  • user_relative_permittivity1Multiplies the permittivity of free space.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Multiplies the permittivity of free space.
                                                                                                  • user_field_enhancement1The field enhancement factor.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The field enhancement factor.
                                                                                                  • time_units1Units of time
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of time
                                                                                                  • user_electron_diffusion_coeff0The electron diffusion coefficient.
                                                                                                    Default:0
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The electron diffusion coefficient.
                                                                                                  • potentialThe potential for calculating the electron velocity
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential for calculating the electron velocity
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • user_electron_mobility0The electron mobility coefficient.
                                                                                                    Default:0
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The electron mobility coefficient.
                                                                                                  • user_p_gasThe gas pressure in Pascals.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The gas pressure in Pascals.
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • user_T_gas300The gas temperature in Kelvin.
                                                                                                    Default:300
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The gas temperature in Kelvin.
                                                                                                  • user_se_coeff0.15The secondary electron emission coefficient.
                                                                                                    Default:0.15
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The secondary electron emission coefficient.
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/HeavySpecies.html b/source/materials/HeavySpecies.html index 190e474593f..8625b3168d1 100644 --- a/source/materials/HeavySpecies.html +++ b/source/materials/HeavySpecies.html @@ -1,4 +1,4 @@ -HeavySpecies|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  HeavySpecies

                                                                                                  under construction:Undocumented Class

                                                                                                  The HeavySpecies has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+HeavySpecies|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  HeavySpecies
                                                                                                  under construction:Undocumented Class
                                                                                                  The HeavySpecies has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # HeavySpecies
 
 !syntax description /Materials/HeavySpecies
@@ -18,7 +18,7 @@
 !syntax children /Materials/HeavySpecies
 
                                                                                                  
 
-!syntax description /Materials/HeavySpecies
                                                                                                  Input Parameters
                                                                                                  • heavy_species_nameThe name of the heavy species
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The name of the heavy species
                                                                                                  • heavy_species_massMass of the heavy species
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Mass of the heavy species
                                                                                                  • potential_unitsThe potential units.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The potential units.
                                                                                                  • heavy_species_chargeCharge of heavy species.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Charge of heavy species.
                                                                                                  Required Parameters
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/HeavySpeciesMaterial.html b/source/materials/HeavySpeciesMaterial.html index 8da8b2bbf16..fbc697ea27f 100644 --- a/source/materials/HeavySpeciesMaterial.html +++ b/source/materials/HeavySpeciesMaterial.html @@ -1,4 +1,4 @@ -HeavySpeciesMaterial|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  HeavySpeciesMaterial

                                                                                                  under construction:Undocumented Class

                                                                                                  The HeavySpeciesMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+HeavySpeciesMaterial|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  HeavySpeciesMaterial
                                                                                                  under construction:Undocumented Class
                                                                                                  The HeavySpeciesMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # HeavySpeciesMaterial
 
 !syntax description /Materials/HeavySpeciesMaterial
@@ -18,7 +18,7 @@
 !syntax children /Materials/HeavySpeciesMaterial
 
                                                                                                  
 
-!syntax description /Materials/HeavySpeciesMaterial
                                                                                                  Input Parameters
                                                                                                  • heavy_species_nameThe name of the heavy species
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The name of the heavy species
                                                                                                  • heavy_species_massMass of the heavy species
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Mass of the heavy species
                                                                                                  • potential_unitsThe potential units.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The potential units.
                                                                                                  • heavy_species_chargeCharge of heavy species.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Charge of heavy species.
                                                                                                  Required Parameters
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • mobilityThe species mobility (if applicable).
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The species mobility (if applicable).
                                                                                                  • time_units1Units of time
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of time
                                                                                                  • diffusivityThe species diffusivity (if applicable).
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The species diffusivity (if applicable).
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/JacMat.html b/source/materials/JacMat.html index f1aee31cbd3..eec61142fd6 100644 --- a/source/materials/JacMat.html +++ b/source/materials/JacMat.html @@ -1,4 +1,4 @@ -JacMat|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  JacMat

                                                                                                  under construction:Undocumented Class

                                                                                                  The JacMat has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+JacMat|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  JacMat
                                                                                                  under construction:Undocumented Class
                                                                                                  The JacMat has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # JacMat
 
 !syntax description /Materials/JacMat
@@ -18,7 +18,7 @@
 !syntax children /Materials/JacMat
 
                                                                                                  
 
-!syntax description /Materials/JacMat
                                                                                                  Input Parameters
                                                                                                  • property_tables_fileThe file containing interpolation tables for material properties.
                                                                                                    C++ Type:FileName
                                                                                                    Options:
                                                                                                    Description:The file containing interpolation tables for material properties.
                                                                                                  Required Parameters
                                                                                                  • emA variable for interpolation tests.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:A variable for interpolation tests.
                                                                                                  • mean_enA variable for interpolation tests.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:A variable for interpolation tests.
                                                                                                  • emliqA variable for interpolation tests.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:A variable for interpolation tests.
                                                                                                  • vA variable for interpolation tests.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:A variable for interpolation tests.
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/SigmaMat.html b/source/materials/SigmaMat.html index 537ffb3e0ae..5c2c93c33fb 100644 --- a/source/materials/SigmaMat.html +++ b/source/materials/SigmaMat.html @@ -1,4 +1,4 @@ -SigmaMat|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  SigmaMat

                                                                                                  under construction:Undocumented Class

                                                                                                  The SigmaMat has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+SigmaMat|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  SigmaMat
                                                                                                  under construction:Undocumented Class
                                                                                                  The SigmaMat has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # SigmaMat
 
 !syntax description /Materials/SigmaMat
@@ -18,7 +18,7 @@
 !syntax children /Materials/SigmaMat
 
                                                                                                  
 
-!syntax description /Materials/SigmaMat
                                                                                                  Input Parameters
                                                                                                  • potentialThe potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential.
                                                                                                  • nThe charge density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The charge density.
                                                                                                  Required Parameters
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/materials/Water.html b/source/materials/Water.html index a64a3e99eb3..6e15f23cae0 100644 --- a/source/materials/Water.html +++ b/source/materials/Water.html @@ -1,4 +1,4 @@ -Water|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  Water

                                                                                                  under construction:Undocumented Class

                                                                                                  The Water has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+Water|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  Water
                                                                                                  under construction:Undocumented Class
                                                                                                  The Water has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # Water
 
 !syntax description /Materials/Water
@@ -18,7 +18,7 @@
 !syntax children /Materials/Water
 
                                                                                                  
 
-!syntax description /Materials/Water
                                                                                                  Input Parameters
                                                                                                  • OHmhydroxide ions
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:hydroxide ions
                                                                                                  • user_electron_mult1Scaling for the electrons.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Scaling for the electrons.
                                                                                                  • HO2mHO2 anions
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:HO2 anions
                                                                                                  • O3ozone molecules
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:ozone molecules
                                                                                                  • O2oxygen molecules
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:oxygen molecules
                                                                                                  • H3Oppositive hydronium cations
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:positive hydronium cations
                                                                                                  • H2O2hydrogen peroxide molecules
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:hydrogen peroxide molecules
                                                                                                  • emliqelectrons
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:electrons
                                                                                                  • potentialThe potential
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential
                                                                                                  • HO2HO2 molecules
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:HO2 molecules
                                                                                                  • O3mozone anions
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:ozone anions
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • Omatomic oxygen anions
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:atomic oxygen anions
                                                                                                  • Hhydrogen atoms
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:hydrogen atoms
                                                                                                  • OHhydroxyl molecules
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:hydroxyl molecules
                                                                                                  • Ooxygen atoms
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:oxygen atoms
                                                                                                  • user_potential_mult1Scaling for the potential.
                                                                                                    Default:1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Scaling for the potential.
                                                                                                  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.
                                                                                                  • H2Oppositive water ions
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:positive water ions
                                                                                                  • H2hydrogen molecules
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:hydrogen molecules
                                                                                                  • user_relative_permittivity78.5The relative permittivity of the medium.
                                                                                                    Default:78.5
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The relative permittivity of the medium.
                                                                                                  • O2mmolecular oxygen anions
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:molecular oxygen anions
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                    Default:NONE
                                                                                                    C++ Type:MooseEnum
                                                                                                    Options:NONE ELEMENT SUBDOMAIN
                                                                                                    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
                                                                                                  Advanced Parameters
                                                                                                  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
                                                                                                  • outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    Default:none 
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  Outputs Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html b/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html index fc2722f294a..7ecba79a3c5 100644 --- a/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html +++ b/source/meshmodifiers/NodeAndSidesetBetweenSubdomains.html @@ -1,4 +1,4 @@ -NodeAndSidesetBetweenSubdomains|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  NodeAndSidesetBetweenSubdomains

                                                                                                  under construction:Undocumented Class

                                                                                                  The NodeAndSidesetBetweenSubdomains has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+NodeAndSidesetBetweenSubdomains|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  NodeAndSidesetBetweenSubdomains
                                                                                                  under construction:Undocumented Class
                                                                                                  The NodeAndSidesetBetweenSubdomains has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # NodeAndSidesetBetweenSubdomains
 
 !syntax description /MeshModifiers/NodeAndSidesetBetweenSubdomains
@@ -18,4 +18,4 @@
 !syntax children /MeshModifiers/NodeAndSidesetBetweenSubdomains
 
                                                                                                  
 
-!syntax description /MeshModifiers/NodeAndSidesetBetweenSubdomains
                                                                                                  Input Parameters
                                                                                                  • master_blockThe first block for which to draw a sideset between
                                                                                                    C++ Type:SubdomainName
                                                                                                    Options:
                                                                                                    Description:The first block for which to draw a sideset between
                                                                                                  • new_boundaryThe name of the boundary to create
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of the boundary to create
                                                                                                  • paired_blockThe second block for which to draw a sideset between
                                                                                                    C++ Type:SubdomainName
                                                                                                    Options:
                                                                                                    Description:The second block for which to draw a sideset between
                                                                                                  Required Parameters
                                                                                                  • force_prepareFalseNormally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preparation between modifiers where they might be needed.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Normally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preparation between modifiers where they might be needed.
                                                                                                  • depends_onThe MeshModifiers that this modifier relies upon (i.e. must execute before this one)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The MeshModifiers that this modifier relies upon (i.e. must execute before this one)
                                                                                                  Optional Parameters
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  Advanced Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /MeshModifiers/NodeAndSidesetBetweenSubdomains
                                                                                                  Input Parameters
                                                                                                  • master_blockThe first block for which to draw a sideset between
                                                                                                    C++ Type:SubdomainName
                                                                                                    Options:
                                                                                                    Description:The first block for which to draw a sideset between
                                                                                                  • new_boundaryThe name of the boundary to create
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of the boundary to create
                                                                                                  • paired_blockThe second block for which to draw a sideset between
                                                                                                    C++ Type:SubdomainName
                                                                                                    Options:
                                                                                                    Description:The second block for which to draw a sideset between
                                                                                                  Required Parameters
                                                                                                  • force_prepareFalseNormally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preparation between modifiers where they might be needed.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Normally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preparation between modifiers where they might be needed.
                                                                                                  • depends_onThe MeshModifiers that this modifier relies upon (i.e. must execute before this one)
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The MeshModifiers that this modifier relies upon (i.e. must execute before this one)
                                                                                                  Optional Parameters
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  Advanced Parameters
                                                                                                  \ No newline at end of file diff --git a/source/postprocessors/PlasmaFrequencyInverse.html b/source/postprocessors/PlasmaFrequencyInverse.html index 0eb676295c5..a5445e76bbb 100644 --- a/source/postprocessors/PlasmaFrequencyInverse.html +++ b/source/postprocessors/PlasmaFrequencyInverse.html @@ -1,4 +1,4 @@ -PlasmaFrequencyInverse|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  PlasmaFrequencyInverse

                                                                                                  under construction:Undocumented Class

                                                                                                  The PlasmaFrequencyInverse has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+PlasmaFrequencyInverse|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  PlasmaFrequencyInverse
                                                                                                  under construction:Undocumented Class
                                                                                                  The PlasmaFrequencyInverse has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # PlasmaFrequencyInverse
 
 !syntax description /Postprocessors/PlasmaFrequencyInverse
@@ -18,7 +18,7 @@
 !syntax children /Postprocessors/PlasmaFrequencyInverse
 
                                                                                                  
 
-!syntax description /Postprocessors/PlasmaFrequencyInverse
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this postprocessor operates on
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this postprocessor operates on
                                                                                                  • use_molesFalseWhether to use units of moles as opposed to # of molecules.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether to use units of moles as opposed to # of molecules.
                                                                                                  Required Parameters
                                                                                                  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                    Default:TIMESTEP_END
                                                                                                    C++ Type:ExecFlagEnum
                                                                                                    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM TRANSFER
                                                                                                    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/postprocessors/SideTotFluxIntegral.html b/source/postprocessors/SideTotFluxIntegral.html index 4dd12a2aab7..cdfe74f7b81 100644 --- a/source/postprocessors/SideTotFluxIntegral.html +++ b/source/postprocessors/SideTotFluxIntegral.html @@ -1,4 +1,4 @@ -SideTotFluxIntegral|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  SideTotFluxIntegral

                                                                                                  under construction:Undocumented Class

                                                                                                  The SideTotFluxIntegral has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+SideTotFluxIntegral|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  SideTotFluxIntegral
                                                                                                  under construction:Undocumented Class
                                                                                                  The SideTotFluxIntegral has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # SideTotFluxIntegral
 
 !syntax description /Postprocessors/SideTotFluxIntegral
@@ -18,7 +18,7 @@
 !syntax children /Postprocessors/SideTotFluxIntegral
 
                                                                                                  
 
-!syntax description /Postprocessors/SideTotFluxIntegral
                                                                                                  Input Parameters
                                                                                                  • mobilityThe name of the mobility material property that will be used in the flux computation.
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                    Description:The name of the mobility material property that will be used in the flux computation.
                                                                                                  • rThe reflection coefficient
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The reflection coefficient
                                                                                                  • position_unitsUnits of position.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Units of position.
                                                                                                  • variableThe name of the variable that this boundary condition applies to
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this boundary condition applies to
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  • potentialThe potential that drives the advective flux.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The potential that drives the advective flux.
                                                                                                  Required Parameters
                                                                                                  • user_velocity-1Optional parameter if user wants to specify the thermal velocity
                                                                                                    Default:-1
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:Optional parameter if user wants to specify the thermal velocity
                                                                                                  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                    Default:TIMESTEP_END
                                                                                                    C++ Type:ExecFlagEnum
                                                                                                    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM TRANSFER
                                                                                                    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                  Optional Parameters
                                                                                                  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/userobjects/BlockAverageValue.html b/source/userobjects/BlockAverageValue.html index 431e5a87b91..0554b4d5d1a 100644 --- a/source/userobjects/BlockAverageValue.html +++ b/source/userobjects/BlockAverageValue.html @@ -1,4 +1,4 @@ -BlockAverageValue|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  BlockAverageValue

                                                                                                  under construction:Undocumented Class

                                                                                                  The BlockAverageValue has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+BlockAverageValue|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  BlockAverageValue
                                                                                                  under construction:Undocumented Class
                                                                                                  The BlockAverageValue has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # BlockAverageValue
 
 !syntax description /Postprocessors/BlockAverageValue
@@ -18,4 +18,4 @@
 !syntax children /Postprocessors/BlockAverageValue
 
                                                                                                  
 
-!syntax description /Postprocessors/BlockAverageValue
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this object operates on
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this object operates on
                                                                                                  Required Parameters
                                                                                                  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                    Default:TIMESTEP_END
                                                                                                    C++ Type:ExecFlagEnum
                                                                                                    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM TRANSFER
                                                                                                    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • built_by_actionadd_user_object
                                                                                                    Default:add_user_object
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  
\ No newline at end of file
+!syntax description /Postprocessors/BlockAverageValue
                                                                                                  Input Parameters
                                                                                                  • variableThe name of the variable that this object operates on
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The name of the variable that this object operates on
                                                                                                  Required Parameters
                                                                                                  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                    Default:TIMESTEP_END
                                                                                                    C++ Type:ExecFlagEnum
                                                                                                    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM TRANSFER
                                                                                                    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                  • blockThe list of block ids (SubdomainID) that this object will be applied
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of block ids (SubdomainID) that this object will be applied
                                                                                                  • built_by_actionadd_user_object
                                                                                                    Default:add_user_object
                                                                                                    C++ Type:std::string
                                                                                                    Options:
                                                                                                  Optional Parameters
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • seed0The seed for the master random number generator
                                                                                                    Default:0
                                                                                                    C++ Type:unsigned int
                                                                                                    Options:
                                                                                                    Description:The seed for the master random number generator
                                                                                                  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Determines whether this object is calculated using an implicit or explicit form
                                                                                                  Advanced Parameters
                                                                                                  \ No newline at end of file diff --git a/source/userobjects/CurrentDensityShapeSideUserObject.html b/source/userobjects/CurrentDensityShapeSideUserObject.html index a1b7b91e68c..7edbc6c8fc4 100644 --- a/source/userobjects/CurrentDensityShapeSideUserObject.html +++ b/source/userobjects/CurrentDensityShapeSideUserObject.html @@ -1,4 +1,4 @@ -CurrentDensityShapeSideUserObject|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  CurrentDensityShapeSideUserObject

                                                                                                  under construction:Undocumented Class

                                                                                                  The CurrentDensityShapeSideUserObject has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+CurrentDensityShapeSideUserObject|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  CurrentDensityShapeSideUserObject
                                                                                                  under construction:Undocumented Class
                                                                                                  The CurrentDensityShapeSideUserObject has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # CurrentDensityShapeSideUserObject
 
 !syntax description /UserObjects/CurrentDensityShapeSideUserObject
@@ -18,7 +18,7 @@
 !syntax children /UserObjects/CurrentDensityShapeSideUserObject
 
                                                                                                  
 
-!syntax description /UserObjects/CurrentDensityShapeSideUserObject
                                                                                                  Input Parameters
                                                                                                  • emThe electron  density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electron  density.
                                                                                                  • mean_enThe mean energy variable.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The mean energy variable.
                                                                                                  • ipThe ion density density.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The ion density density.
                                                                                                  • potentialThe electrical potential.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The electrical potential.
                                                                                                  • use_molesFalseWhether the densities are in molar units.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether the densities are in molar units.
                                                                                                  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:The list of boundary IDs from the mesh where this boundary condition applies
                                                                                                  Required Parameters
                                                                                                  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                    Default:TIMESTEP_END
                                                                                                    C++ Type:ExecFlagEnum
                                                                                                    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM
                                                                                                    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                  Optional Parameters
                                                                                                  • compute_jacobiansTrueCompute Jacobians for coupled variables
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Compute Jacobians for coupled variables
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/source/userobjects/ProvideMobility.html b/source/userobjects/ProvideMobility.html index 2f29ae2dcbb..725c03df285 100644 --- a/source/userobjects/ProvideMobility.html +++ b/source/userobjects/ProvideMobility.html @@ -1,4 +1,4 @@ -ProvideMobility|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  ProvideMobility

                                                                                                  under construction:Undocumented Class

                                                                                                  The ProvideMobility has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                  
+ProvideMobility|Zapdos
                                                                                                  Code Documentation
                                                                                                  Application Development
                                                                                                  Questions and General Information
                                                                                                  Developer Information (from MOOSE website)
                                                                                                  ProvideMobility
                                                                                                  under construction:Undocumented Class
                                                                                                  The ProvideMobility has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                  
 # ProvideMobility
 
 !syntax description /UserObjects/ProvideMobility
@@ -18,7 +18,7 @@
 !syntax children /UserObjects/ProvideMobility
 
                                                                                                  
 
-!syntax description /UserObjects/ProvideMobility
                                                                                                  Input Parameters
                                                                                                  • eThe Coulomb charge
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The Coulomb charge
                                                                                                  • ballast_resistThe magnitude of the ballasting resistance.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The magnitude of the ballasting resistance.
                                                                                                  • electrode_areaThe area of the electrode or plasma.
                                                                                                    C++ Type:double
                                                                                                    Options:
                                                                                                    Description:The area of the electrode or plasma.
                                                                                                  Required Parameters
                                                                                                  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                    Default:TIMESTEP_END
                                                                                                    C++ Type:ExecFlagEnum
                                                                                                    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM
                                                                                                    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
                                                                                                  Optional Parameters
                                                                                                  • control_tagsAdds user-defined labels for accessing object parameters via control logic.
                                                                                                    C++ Type:std::vector
                                                                                                    Options:
                                                                                                    Description:Adds user-defined labels for accessing object parameters via control logic.
                                                                                                  • enableTrueSet the enabled status of the MooseObject.
                                                                                                    Default:True
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Set the enabled status of the MooseObject.
                                                                                                  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
                                                                                                  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Forces the GeneralUserObject to be executed in PREAUX
                                                                                                  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                    Default:False
                                                                                                    C++ Type:bool
                                                                                                    Options:
                                                                                                    Description:Whether or not this object should use the displaced mesh for computation.  Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
                                                                                                  Advanced Parameters
                                                                                                  Input Files
                                                                                                  
\ No newline at end of file
+
                                                                                                  Close
                                                                                                  \ No newline at end of file diff --git a/syntax/Actions/index.html b/syntax/Actions/index.html index b7786ddbd75..75f9fcbdb8d 100644 --- a/syntax/Actions/index.html +++ b/syntax/Actions/index.html @@ -1 +1 @@ -Actions System|Zapdos

                                                                                                  Code Documentation

                                                                                                  Application Development

                                                                                                  Questions and General Information

                                                                                                  Developer Information (from MOOSE website)

                                                                                                  Actions System

                                                                                                    \ No newline at end of file +Actions System|Zapdos

                                                                                                    Code Documentation

                                                                                                    Application Development

                                                                                                    Questions and General Information

                                                                                                    Developer Information (from MOOSE website)

                                                                                                    Actions System

                                                                                                      \ No newline at end of file diff --git a/syntax/Adaptivity/Indicators/index.html b/syntax/Adaptivity/Indicators/index.html index f853f734270..30031ba7cb9 100644 --- a/syntax/Adaptivity/Indicators/index.html +++ b/syntax/Adaptivity/Indicators/index.html @@ -1 +1 @@ -Adaptivity Indicators System|Zapdos

                                                                                                      Code Documentation

                                                                                                      Application Development

                                                                                                      Questions and General Information

                                                                                                      Developer Information (from MOOSE website)

                                                                                                      Adaptivity Indicators System

                                                                                                        \ No newline at end of file +Adaptivity Indicators System|Zapdos

                                                                                                        Code Documentation

                                                                                                        Application Development

                                                                                                        Questions and General Information

                                                                                                        Developer Information (from MOOSE website)

                                                                                                        Adaptivity Indicators System

                                                                                                          \ No newline at end of file diff --git a/syntax/Adaptivity/index.html b/syntax/Adaptivity/index.html index 37da454d005..104c752213a 100644 --- a/syntax/Adaptivity/index.html +++ b/syntax/Adaptivity/index.html @@ -1 +1 @@ -Adaptivity System|Zapdos

                                                                                                          Code Documentation

                                                                                                          Application Development

                                                                                                          Questions and General Information

                                                                                                          Developer Information (from MOOSE website)

                                                                                                          Adaptivity System

                                                                                                            \ No newline at end of file +Adaptivity System|Zapdos

                                                                                                            Code Documentation

                                                                                                            Application Development

                                                                                                            Questions and General Information

                                                                                                            Developer Information (from MOOSE website)

                                                                                                            Adaptivity System

                                                                                                              \ No newline at end of file diff --git a/syntax/AuxKernels/index.html b/syntax/AuxKernels/index.html index ba5430ff714..3cd2376e827 100644 --- a/syntax/AuxKernels/index.html +++ b/syntax/AuxKernels/index.html @@ -1 +1 @@ -AuxKernels System|Zapdos

                                                                                                              Code Documentation

                                                                                                              Application Development

                                                                                                              Questions and General Information

                                                                                                              Developer Information (from MOOSE website)

                                                                                                              AuxKernels System

                                                                                                                \ No newline at end of file +AuxKernels System|Zapdos

                                                                                                                Code Documentation

                                                                                                                Application Development

                                                                                                                Questions and General Information

                                                                                                                Developer Information (from MOOSE website)

                                                                                                                AuxKernels System

                                                                                                                  \ No newline at end of file diff --git a/syntax/BCs/index.html b/syntax/BCs/index.html index 626ec9f69b8..761ac1776de 100644 --- a/syntax/BCs/index.html +++ b/syntax/BCs/index.html @@ -1 +1 @@ -Boundary Conditions System|Zapdos

                                                                                                                  Code Documentation

                                                                                                                  Application Development

                                                                                                                  Questions and General Information

                                                                                                                  Developer Information (from MOOSE website)

                                                                                                                  Boundary Conditions System

                                                                                                                    \ No newline at end of file +Boundary Conditions System|Zapdos

                                                                                                                    Code Documentation

                                                                                                                    Application Development

                                                                                                                    Questions and General Information

                                                                                                                    Developer Information (from MOOSE website)

                                                                                                                    Boundary Conditions System

                                                                                                                      \ No newline at end of file diff --git a/syntax/Bounds/index.html b/syntax/Bounds/index.html index a3d468f3211..018e1cb3b8b 100644 --- a/syntax/Bounds/index.html +++ b/syntax/Bounds/index.html @@ -1 +1 @@ -Bounds System|Zapdos

                                                                                                                      Code Documentation

                                                                                                                      Application Development

                                                                                                                      Questions and General Information

                                                                                                                      Developer Information (from MOOSE website)

                                                                                                                      Bounds System

                                                                                                                        \ No newline at end of file +Bounds System|Zapdos

                                                                                                                        Code Documentation

                                                                                                                        Application Development

                                                                                                                        Questions and General Information

                                                                                                                        Developer Information (from MOOSE website)

                                                                                                                        Bounds System

                                                                                                                          \ No newline at end of file diff --git a/syntax/Constraints/index.html b/syntax/Constraints/index.html index 33ed448ec60..650e5927166 100644 --- a/syntax/Constraints/index.html +++ b/syntax/Constraints/index.html @@ -1 +1 @@ -Constraints System|Zapdos

                                                                                                                          Code Documentation

                                                                                                                          Application Development

                                                                                                                          Questions and General Information

                                                                                                                          Developer Information (from MOOSE website)

                                                                                                                          Constraints System

                                                                                                                            \ No newline at end of file +Constraints System|Zapdos

                                                                                                                            Code Documentation

                                                                                                                            Application Development

                                                                                                                            Questions and General Information

                                                                                                                            Developer Information (from MOOSE website)

                                                                                                                            Constraints System

                                                                                                                              \ No newline at end of file diff --git a/syntax/DGKernels/index.html b/syntax/DGKernels/index.html index 149907a9d95..61b4de0e30b 100644 --- a/syntax/DGKernels/index.html +++ b/syntax/DGKernels/index.html @@ -1 +1 @@ -DGKernels System|Zapdos

                                                                                                                              Code Documentation

                                                                                                                              Application Development

                                                                                                                              Questions and General Information

                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                              DGKernels System

                                                                                                                                \ No newline at end of file +DGKernels System|Zapdos

                                                                                                                                Code Documentation

                                                                                                                                Application Development

                                                                                                                                Questions and General Information

                                                                                                                                Developer Information (from MOOSE website)

                                                                                                                                DGKernels System

                                                                                                                                  \ No newline at end of file diff --git a/syntax/Indicators/index.html b/syntax/Indicators/index.html index 7000d4fe63c..eb3d131198d 100644 --- a/syntax/Indicators/index.html +++ b/syntax/Indicators/index.html @@ -1 +1 @@ -Indicators System|Zapdos

                                                                                                                                  Code Documentation

                                                                                                                                  Application Development

                                                                                                                                  Questions and General Information

                                                                                                                                  Developer Information (from MOOSE website)

                                                                                                                                  Indicators System

                                                                                                                                    \ No newline at end of file +Indicators System|Zapdos

                                                                                                                                    Code Documentation

                                                                                                                                    Application Development

                                                                                                                                    Questions and General Information

                                                                                                                                    Developer Information (from MOOSE website)

                                                                                                                                    Indicators System

                                                                                                                                      \ No newline at end of file diff --git a/syntax/InterfaceKernels/index.html b/syntax/InterfaceKernels/index.html index 68c2f094b35..95692b448cb 100644 --- a/syntax/InterfaceKernels/index.html +++ b/syntax/InterfaceKernels/index.html @@ -1 +1 @@ -InterfaceKernels System|Zapdos

                                                                                                                                      Code Documentation

                                                                                                                                      Application Development

                                                                                                                                      Questions and General Information

                                                                                                                                      Developer Information (from MOOSE website)

                                                                                                                                      InterfaceKernels System

                                                                                                                                        \ No newline at end of file +InterfaceKernels System|Zapdos

                                                                                                                                        Code Documentation

                                                                                                                                        Application Development

                                                                                                                                        Questions and General Information

                                                                                                                                        Developer Information (from MOOSE website)

                                                                                                                                        InterfaceKernels System

                                                                                                                                          \ No newline at end of file diff --git a/syntax/Kernels/index.html b/syntax/Kernels/index.html index cb1325f5986..5f36caf2386 100644 --- a/syntax/Kernels/index.html +++ b/syntax/Kernels/index.html @@ -1 +1 @@ -Kernels System|Zapdos

                                                                                                                                          Code Documentation

                                                                                                                                          Application Development

                                                                                                                                          Questions and General Information

                                                                                                                                          Developer Information (from MOOSE website)

                                                                                                                                          Kernels System

                                                                                                                                            \ No newline at end of file +Kernels System|Zapdos

                                                                                                                                            Code Documentation

                                                                                                                                            Application Development

                                                                                                                                            Questions and General Information

                                                                                                                                            Developer Information (from MOOSE website)

                                                                                                                                            Kernels System

                                                                                                                                              \ No newline at end of file diff --git a/syntax/LotsOfCoeffDiffusion/index.html b/syntax/LotsOfCoeffDiffusion/index.html index 5eda115f72a..f324b62dc21 100644 --- a/syntax/LotsOfCoeffDiffusion/index.html +++ b/syntax/LotsOfCoeffDiffusion/index.html @@ -1,4 +1,4 @@ -LotsOfCoeffDiffusion System|Zapdos

                                                                                                                                              Code Documentation

                                                                                                                                              Application Development

                                                                                                                                              Questions and General Information

                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                              LotsOfCoeffDiffusion System

                                                                                                                                              under construction:Undocumented System

                                                                                                                                              The LotsOfCoeffDiffusion system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                                                              
+LotsOfCoeffDiffusion System|Zapdos
                                                                                                                                              Code Documentation
                                                                                                                                              Application Development
                                                                                                                                              Questions and General Information
                                                                                                                                              Developer Information (from MOOSE website)
                                                                                                                                              LotsOfCoeffDiffusion System
                                                                                                                                              under construction:Undocumented System
                                                                                                                                              The LotsOfCoeffDiffusion system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                                                              
 # LotsOfCoeffDiffusion System
 
 ## Overview
@@ -14,4 +14,4 @@
 !syntax list /LotsOfCoeffDiffusion objects=False actions=False subsystems=True
 
 !syntax list /LotsOfCoeffDiffusion objects=False actions=True subsystems=False
-
                                                                                                                                              Available Objects
                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec
                                                                                                                                              Available Actions
                                                                                                                                              
\ No newline at end of file
+

                                                                                                                                              Available Objects

                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec

                                                                                                                                              Available Actions

                                                                                                                                              \ No newline at end of file diff --git a/syntax/LotsOfEFieldAdvection/index.html b/syntax/LotsOfEFieldAdvection/index.html index 897982db763..eae1b4c38f6 100644 --- a/syntax/LotsOfEFieldAdvection/index.html +++ b/syntax/LotsOfEFieldAdvection/index.html @@ -1,4 +1,4 @@ -LotsOfEFieldAdvection System|Zapdos

                                                                                                                                              Code Documentation

                                                                                                                                              Application Development

                                                                                                                                              Questions and General Information

                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                              LotsOfEFieldAdvection System

                                                                                                                                              under construction:Undocumented System

                                                                                                                                              The LotsOfEFieldAdvection system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                                                              
+LotsOfEFieldAdvection System|Zapdos
                                                                                                                                              Code Documentation
                                                                                                                                              Application Development
                                                                                                                                              Questions and General Information
                                                                                                                                              Developer Information (from MOOSE website)
                                                                                                                                              LotsOfEFieldAdvection System
                                                                                                                                              under construction:Undocumented System
                                                                                                                                              The LotsOfEFieldAdvection system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                                                              
 # LotsOfEFieldAdvection System
 
 ## Overview
@@ -14,4 +14,4 @@
 !syntax list /LotsOfEFieldAdvection objects=False actions=False subsystems=True
 
 !syntax list /LotsOfEFieldAdvection objects=False actions=True subsystems=False
-
                                                                                                                                              Available Objects
                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec
                                                                                                                                              Available Actions
                                                                                                                                              
\ No newline at end of file
+

                                                                                                                                              Available Objects

                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec

                                                                                                                                              Available Actions

                                                                                                                                              \ No newline at end of file diff --git a/syntax/LotsOfPotentialDrivenArtificialDiff/index.html b/syntax/LotsOfPotentialDrivenArtificialDiff/index.html index 58d85b182d6..e5a258359dd 100644 --- a/syntax/LotsOfPotentialDrivenArtificialDiff/index.html +++ b/syntax/LotsOfPotentialDrivenArtificialDiff/index.html @@ -1,4 +1,4 @@ -LotsOfPotentialDrivenArtificialDiff System|Zapdos

                                                                                                                                              Code Documentation

                                                                                                                                              Application Development

                                                                                                                                              Questions and General Information

                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                              LotsOfPotentialDrivenArtificialDiff System

                                                                                                                                              under construction:Undocumented System

                                                                                                                                              The LotsOfPotentialDrivenArtificialDiff system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                                                              
+LotsOfPotentialDrivenArtificialDiff System|Zapdos
                                                                                                                                              Code Documentation
                                                                                                                                              Application Development
                                                                                                                                              Questions and General Information
                                                                                                                                              Developer Information (from MOOSE website)
                                                                                                                                              LotsOfPotentialDrivenArtificialDiff System
                                                                                                                                              under construction:Undocumented System
                                                                                                                                              The LotsOfPotentialDrivenArtificialDiff system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                                                              
 # LotsOfPotentialDrivenArtificialDiff System
 
 ## Overview
@@ -14,4 +14,4 @@
 !syntax list /LotsOfPotentialDrivenArtificialDiff objects=False actions=False subsystems=True
 
 !syntax list /LotsOfPotentialDrivenArtificialDiff objects=False actions=True subsystems=False
-
                                                                                                                                              Available Objects
                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec
                                                                                                                                              Available Actions
                                                                                                                                              
\ No newline at end of file
+

                                                                                                                                              Available Objects

                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec

                                                                                                                                              Available Actions

                                                                                                                                              \ No newline at end of file diff --git a/syntax/LotsOfSources/index.html b/syntax/LotsOfSources/index.html index 0fcdb182763..cee886b8291 100644 --- a/syntax/LotsOfSources/index.html +++ b/syntax/LotsOfSources/index.html @@ -1,4 +1,4 @@ -LotsOfSources System|Zapdos

                                                                                                                                              Code Documentation

                                                                                                                                              Application Development

                                                                                                                                              Questions and General Information

                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                              LotsOfSources System

                                                                                                                                              under construction:Undocumented System

                                                                                                                                              The LotsOfSources system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                                                              
+LotsOfSources System|Zapdos
                                                                                                                                              Code Documentation
                                                                                                                                              Application Development
                                                                                                                                              Questions and General Information
                                                                                                                                              Developer Information (from MOOSE website)
                                                                                                                                              LotsOfSources System
                                                                                                                                              under construction:Undocumented System
                                                                                                                                              The LotsOfSources system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                                                              
 # LotsOfSources System
 
 ## Overview
@@ -14,4 +14,4 @@
 !syntax list /LotsOfSources objects=False actions=False subsystems=True
 
 !syntax list /LotsOfSources objects=False actions=True subsystems=False
-
                                                                                                                                              Available Objects
                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec
                                                                                                                                              Available Actions
                                                                                                                                              
\ No newline at end of file
+

                                                                                                                                              Available Objects

                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec

                                                                                                                                              Available Actions

                                                                                                                                              \ No newline at end of file diff --git a/syntax/LotsOfTimeDerivatives/index.html b/syntax/LotsOfTimeDerivatives/index.html index 469978da86c..db5f25881ba 100644 --- a/syntax/LotsOfTimeDerivatives/index.html +++ b/syntax/LotsOfTimeDerivatives/index.html @@ -1,4 +1,4 @@ -LotsOfTimeDerivatives System|Zapdos

                                                                                                                                              Code Documentation

                                                                                                                                              Application Development

                                                                                                                                              Questions and General Information

                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                              LotsOfTimeDerivatives System

                                                                                                                                              under construction:Undocumented System

                                                                                                                                              The LotsOfTimeDerivatives system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                                                              
+LotsOfTimeDerivatives System|Zapdos
                                                                                                                                              Code Documentation
                                                                                                                                              Application Development
                                                                                                                                              Questions and General Information
                                                                                                                                              Developer Information (from MOOSE website)
                                                                                                                                              LotsOfTimeDerivatives System
                                                                                                                                              under construction:Undocumented System
                                                                                                                                              The LotsOfTimeDerivatives system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                                                              
 # LotsOfTimeDerivatives System
 
 ## Overview
@@ -14,4 +14,4 @@
 !syntax list /LotsOfTimeDerivatives objects=False actions=False subsystems=True
 
 !syntax list /LotsOfTimeDerivatives objects=False actions=True subsystems=False
-
                                                                                                                                              Available Objects
                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec
                                                                                                                                              Available Actions
                                                                                                                                              
\ No newline at end of file
+

                                                                                                                                              Available Objects

                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec

                                                                                                                                              Available Actions

                                                                                                                                              \ No newline at end of file diff --git a/syntax/LotsOfVariables/index.html b/syntax/LotsOfVariables/index.html index 941821b4bca..1b9bcaaee59 100644 --- a/syntax/LotsOfVariables/index.html +++ b/syntax/LotsOfVariables/index.html @@ -1,4 +1,4 @@ -LotsOfVariables System|Zapdos

                                                                                                                                              Code Documentation

                                                                                                                                              Application Development

                                                                                                                                              Questions and General Information

                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                              LotsOfVariables System

                                                                                                                                              under construction:Undocumented System

                                                                                                                                              The LotsOfVariables system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

                                                                                                                                              
+LotsOfVariables System|Zapdos
                                                                                                                                              Code Documentation
                                                                                                                                              Application Development
                                                                                                                                              Questions and General Information
                                                                                                                                              Developer Information (from MOOSE website)
                                                                                                                                              LotsOfVariables System
                                                                                                                                              under construction:Undocumented System
                                                                                                                                              The LotsOfVariables system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
                                                                                                                                              
 # LotsOfVariables System
 
 ## Overview
@@ -14,4 +14,4 @@
 !syntax list /LotsOfVariables objects=False actions=False subsystems=True
 
 !syntax list /LotsOfVariables objects=False actions=True subsystems=False
-
                                                                                                                                              Available Objects
                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec
                                                                                                                                              Available Actions
                                                                                                                                              
\ No newline at end of file
+

                                                                                                                                              Available Objects

                                                                                                                                              • Moose App
                                                                                                                                              • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
                                                                                                                                              • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
                                                                                                                                              • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
                                                                                                                                              • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
                                                                                                                                              • MooseVariableScalarMoose wrapper class around scalar variables
                                                                                                                                              • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange or Nedelec

                                                                                                                                              Available Actions

                                                                                                                                              \ No newline at end of file diff --git a/syntax/Materials/index.html b/syntax/Materials/index.html index a368589e88a..4468026d8c6 100644 --- a/syntax/Materials/index.html +++ b/syntax/Materials/index.html @@ -1 +1 @@ -Materials System|Zapdos

                                                                                                                                              Code Documentation

                                                                                                                                              Application Development

                                                                                                                                              Questions and General Information

                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                              Materials System

                                                                                                                                                \ No newline at end of file +Materials System|Zapdos

                                                                                                                                                Code Documentation

                                                                                                                                                Application Development

                                                                                                                                                Questions and General Information

                                                                                                                                                Developer Information (from MOOSE website)

                                                                                                                                                Materials System

                                                                                                                                                  \ No newline at end of file diff --git a/syntax/MeshModifiers/index.html b/syntax/MeshModifiers/index.html index 53ebb1c8988..4df33b131eb 100644 --- a/syntax/MeshModifiers/index.html +++ b/syntax/MeshModifiers/index.html @@ -1 +1 @@ -MeshModifiers System|Zapdos

                                                                                                                                                  Code Documentation

                                                                                                                                                  Application Development

                                                                                                                                                  Questions and General Information

                                                                                                                                                  Developer Information (from MOOSE website)

                                                                                                                                                  MeshModifiers System

                                                                                                                                                    \ No newline at end of file +MeshModifiers System|Zapdos

                                                                                                                                                    Code Documentation

                                                                                                                                                    Application Development

                                                                                                                                                    Questions and General Information

                                                                                                                                                    Developer Information (from MOOSE website)

                                                                                                                                                    MeshModifiers System

                                                                                                                                                      \ No newline at end of file diff --git a/syntax/Postprocessors/index.html b/syntax/Postprocessors/index.html index 4481b275b0f..3fccf45d5b0 100644 --- a/syntax/Postprocessors/index.html +++ b/syntax/Postprocessors/index.html @@ -1 +1 @@ -Postprocessors System|Zapdos

                                                                                                                                                      Code Documentation

                                                                                                                                                      Application Development

                                                                                                                                                      Questions and General Information

                                                                                                                                                      Developer Information (from MOOSE website)

                                                                                                                                                      Postprocessors System

                                                                                                                                                        \ No newline at end of file +Postprocessors System|Zapdos

                                                                                                                                                        Code Documentation

                                                                                                                                                        Application Development

                                                                                                                                                        Questions and General Information

                                                                                                                                                        Developer Information (from MOOSE website)

                                                                                                                                                        Postprocessors System

                                                                                                                                                          \ No newline at end of file diff --git a/syntax/UserObjects/index.html b/syntax/UserObjects/index.html index 3ca38a21d3f..ecdc7889418 100644 --- a/syntax/UserObjects/index.html +++ b/syntax/UserObjects/index.html @@ -1 +1 @@ -UserObjects System|Zapdos

                                                                                                                                                          Code Documentation

                                                                                                                                                          Application Development

                                                                                                                                                          Questions and General Information

                                                                                                                                                          Developer Information (from MOOSE website)

                                                                                                                                                          UserObjects System

                                                                                                                                                            \ No newline at end of file +UserObjects System|Zapdos

                                                                                                                                                            Code Documentation

                                                                                                                                                            Application Development

                                                                                                                                                            Questions and General Information

                                                                                                                                                            Developer Information (from MOOSE website)

                                                                                                                                                            UserObjects System

                                                                                                                                                              \ No newline at end of file diff --git a/syntax/index.html b/syntax/index.html index d8a246e7e6e..3d7d929c589 100644 --- a/syntax/index.html +++ b/syntax/index.html @@ -1 +1 @@ -Complete Syntax|Zapdos

                                                                                                                                                              Code Documentation

                                                                                                                                                              Application Development

                                                                                                                                                              Questions and General Information

                                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                                              Complete Syntax

                                                                                                                                                              Adaptivity

                                                                                                                                                              Adaptivity/Indicators

                                                                                                                                                              AuxKernels

                                                                                                                                                              BCs

                                                                                                                                                              Bounds

                                                                                                                                                              Constraints

                                                                                                                                                              DGKernels

                                                                                                                                                              InterfaceKernels

                                                                                                                                                              Kernels

                                                                                                                                                              LotsOfCoeffDiffusion

                                                                                                                                                              LotsOfEFieldAdvection

                                                                                                                                                              LotsOfPotentialDrivenArtificialDiff

                                                                                                                                                              LotsOfSources

                                                                                                                                                              LotsOfTimeDerivatives

                                                                                                                                                              LotsOfVariables

                                                                                                                                                              Materials

                                                                                                                                                              MeshModifiers

                                                                                                                                                              Postprocessors

                                                                                                                                                              UserObjects

                                                                                                                                                              \ No newline at end of file +Complete Syntax|Zapdos

                                                                                                                                                              Code Documentation

                                                                                                                                                              Application Development

                                                                                                                                                              Questions and General Information

                                                                                                                                                              Developer Information (from MOOSE website)

                                                                                                                                                              Complete Syntax

                                                                                                                                                              Adaptivity

                                                                                                                                                              Adaptivity/Indicators

                                                                                                                                                              AuxKernels

                                                                                                                                                              BCs

                                                                                                                                                              Bounds

                                                                                                                                                              Constraints

                                                                                                                                                              DGKernels

                                                                                                                                                              InterfaceKernels

                                                                                                                                                              Kernels

                                                                                                                                                              LotsOfCoeffDiffusion

                                                                                                                                                              LotsOfEFieldAdvection

                                                                                                                                                              LotsOfPotentialDrivenArtificialDiff

                                                                                                                                                              LotsOfSources

                                                                                                                                                              LotsOfTimeDerivatives

                                                                                                                                                              LotsOfVariables

                                                                                                                                                              Materials

                                                                                                                                                              MeshModifiers

                                                                                                                                                              Postprocessors

                                                                                                                                                              UserObjects

                                                                                                                                                              \ No newline at end of file