Chi-Tech
Data Structures | Public Member Functions
chi_physics::MultiGroupXS Class Referenceabstract

#include <multigroup_xs.h>

Inheritance diagram for chi_physics::MultiGroupXS:
chi_physics::MaterialProperty chi_physics::AdjointMGXS chi_physics::SingleStateMGXS

Data Structures

struct  Precursor
 

Public Member Functions

 MultiGroupXS ()
 
void ExportToChiXSFile (const std::string &file_name, const double fission_scaling=1.0) const
 
void PushLuaTable (lua_State *L) const override
 
virtual const unsigned int NumGroups () const =0
 
virtual const unsigned int ScatteringOrder () const =0
 
virtual const unsigned int NumPrecursors () const =0
 
virtual const bool IsFissionable () const =0
 
virtual const bool DiffusionInitialized () const =0
 
virtual const bool ScatteringInitialized () const =0
 
virtual const std::vector< double > & SigmaTotal () const =0
 
virtual const std::vector< double > & SigmaAbsorption () const =0
 
virtual const std::vector< double > & SigmaFission () const =0
 
virtual const std::vector< double > & NuSigmaF () const =0
 
virtual const std::vector< double > & NuPromptSigmaF () const =0
 
virtual const std::vector< double > & NuDelayedSigmaF () const =0
 
virtual const std::vector< double > & InverseVelocity () const =0
 
virtual const std::vector< chi_math::SparseMatrix > & TransferMatrices () const =0
 
virtual const chi_math::SparseMatrix & TransferMatrix (unsigned int ell) const =0
 
virtual const std::vector< std::vector< double > > ProductionMatrix () const =0
 
virtual const std::vector< Precursor > & Precursors () const =0
 
virtual const std::vector< double > & DiffusionCoefficient () const =0
 
virtual std::vector< double > SigmaTransport () const =0
 
virtual const std::vector< double > & SigmaRemoval () const =0
 
virtual const std::vector< double > & SigmaSGtoG () const =0
 
- Public Member Functions inherited from chi_physics::MaterialProperty
 MaterialProperty (PropertyType in_type)
 
virtual ~MaterialProperty ()=default
 
PropertyType Type ()
 
virtual double GetScalarValue ()
 
virtual void PushLuaTable (lua_State *L) const
 

Additional Inherited Members

- Data Fields inherited from chi_physics::MaterialProperty
std::string property_name
 

Detailed Description

Definition at line 12 of file multigroup_xs.h.

Constructor & Destructor Documentation

◆ MultiGroupXS()

chi_physics::MultiGroupXS::MultiGroupXS ( )
inline

Definition at line 25 of file multigroup_xs.h.

Member Function Documentation

◆ DiffusionCoefficient()

virtual const std::vector< double > & chi_physics::MultiGroupXS::DiffusionCoefficient ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ DiffusionInitialized()

virtual const bool chi_physics::MultiGroupXS::DiffusionInitialized ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ ExportToChiXSFile()

void chi_physics::MultiGroupXS::ExportToChiXSFile ( const std::string &  file_name,
const double  fission_scaling = 1.0 
) const

Exports the cross section information to ChiTech format.

Parameters
file_nameThe name of the file to save the cross sections to.
fission_scalingA factor to scale fission data to. This is generally equal to $ 1/k_{eff} $. Generally, this is done to create exactly critical cross sections for a transient initial condition.

Lambda to print a 1D-xs

Definition at line 19 of file multigroup_xs_export.cc.

◆ InverseVelocity()

virtual const std::vector< double > & chi_physics::MultiGroupXS::InverseVelocity ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ IsFissionable()

virtual const bool chi_physics::MultiGroupXS::IsFissionable ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ NuDelayedSigmaF()

virtual const std::vector< double > & chi_physics::MultiGroupXS::NuDelayedSigmaF ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ NumGroups()

virtual const unsigned int chi_physics::MultiGroupXS::NumGroups ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ NumPrecursors()

virtual const unsigned int chi_physics::MultiGroupXS::NumPrecursors ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ NuPromptSigmaF()

virtual const std::vector< double > & chi_physics::MultiGroupXS::NuPromptSigmaF ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ NuSigmaF()

virtual const std::vector< double > & chi_physics::MultiGroupXS::NuSigmaF ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ Precursors()

virtual const std::vector< Precursor > & chi_physics::MultiGroupXS::Precursors ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ ProductionMatrix()

virtual const std::vector< std::vector< double > > chi_physics::MultiGroupXS::ProductionMatrix ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ PushLuaTable()

void chi_physics::MultiGroupXS::PushLuaTable ( lua_State *  L) const
overridevirtual

Pushes all of the relevant items of the transport xs to a lua table.

Reimplemented from chi_physics::MaterialProperty.

Definition at line 7 of file multigroup_xs_pushlua.cc.

◆ ScatteringInitialized()

virtual const bool chi_physics::MultiGroupXS::ScatteringInitialized ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ ScatteringOrder()

virtual const unsigned int chi_physics::MultiGroupXS::ScatteringOrder ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ SigmaAbsorption()

virtual const std::vector< double > & chi_physics::MultiGroupXS::SigmaAbsorption ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ SigmaFission()

virtual const std::vector< double > & chi_physics::MultiGroupXS::SigmaFission ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ SigmaRemoval()

virtual const std::vector< double > & chi_physics::MultiGroupXS::SigmaRemoval ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ SigmaSGtoG()

virtual const std::vector< double > & chi_physics::MultiGroupXS::SigmaSGtoG ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ SigmaTotal()

virtual const std::vector< double > & chi_physics::MultiGroupXS::SigmaTotal ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ SigmaTransport()

virtual std::vector< double > chi_physics::MultiGroupXS::SigmaTransport ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ TransferMatrices()

virtual const std::vector< chi_math::SparseMatrix > & chi_physics::MultiGroupXS::TransferMatrices ( ) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

◆ TransferMatrix()

virtual const chi_math::SparseMatrix & chi_physics::MultiGroupXS::TransferMatrix ( unsigned int  ell) const
pure virtual

Implemented in chi_physics::AdjointMGXS, and chi_physics::SingleStateMGXS.

The documentation for this class was generated from the following files: