Represents the state of the problem. More...
Inheritance diagram for State:
Collaboration diagram for State:
Public Member Functions | |
| function | State (in input, in mesh, in quadrature) |
| Class constructor. | |
| function | flux (in this, in g) |
| Get a group flux vector. | |
| function | eigenvalue (in this) |
| Get the last computed eigenvalue. | |
| function | boundary (in this) |
| Get the boundary fluxes. | |
| function | set_phi (in this, in phi, in g) |
| Set a group flux vector. | |
| function | reset_phi (in this) |
| function | set_eigenvalue (in this, in eigenvalue) |
| Set the eigenvalue. | |
| function | set_boundary (in this, in boundary) |
| Set the boundary fluxes. | |
Private Attributes | |
| Property | d_phi |
| Cell center scalar flux (only isotropic at this point) | |
| Property | d_eigenvalue |
| Eigenvalue. | |
| Property | d_mesh |
| Mesh. | |
| Property | d_boundary |
| Boundary fluxes. | |
| Property | d_number_groups |
| Number of groups. | |
Detailed Description
Represents the state of the problem.
This contains everything that needs to be known throughout most of the problem. The scalar flux (and maybe moments later on), an eigenvalue, and boundary fluxes all live here.
Constructor & Destructor Documentation
| function State | ( | in | input, |
| in | mesh, | ||
| in | quadrature | ||
| ) |
Class constructor.
More detailed description of what the constructor does.
- Parameters:
-
input User input. mesh Problem mesh. quadrature Angular quadrature.
- Returns:
- Instance of the State class.
Member Function Documentation
| function boundary | ( | in | this | ) |
Get the boundary fluxes.
- Returns:
- Eigenvalue (i.e. keff)
| function eigenvalue | ( | in | this | ) |
Get the last computed eigenvalue.
- Returns:
- Eigenvalue (i.e. keff)
| function flux | ( | in | this, |
| in | g | ||
| ) |
Get a group flux vector.
- Parameters:
-
g Energy group.
- Returns:
- Flux vector for all cells.
| function reset_phi | ( | in | this | ) |
| function set_boundary | ( | in | this, |
| in | boundary | ||
| ) |
Set the boundary fluxes.
- Parameters:
-
boundary Boundary flux object.
| function set_eigenvalue | ( | in | this, |
| in | eigenvalue | ||
| ) |
Set the eigenvalue.
- Parameters:
-
eigenvalue Eigenvalue estimate.
| function set_phi | ( | in | this, |
| in | phi, | ||
| in | g | ||
| ) |
Set a group flux vector.
- Parameters:
-
phi Flux vector. g Energy group.
Member Data Documentation
Property d_boundary [private] |
Boundary fluxes.
Property d_eigenvalue [private] |
Eigenvalue.
Property d_number_groups [private] |
Number of groups.
Property d_phi [private] |
Cell center scalar flux (only isotropic at this point)
The documentation for this class was generated from the following file:
- /home/robertsj/Research/matlab_transport_pack/source/State.m
