CYCLUS
Public Member Functions | List of all members
cyclus::toolkit::MatQuery Class Reference

Detailed Description

A class that provides convenience methods for querying a material's properties.

Definition at line 12 of file mat_query.h.

#include <mat_query.h>

Public Member Functions

bool AlmostEq (Material::Ptr other, double threshold=eps_rsrc())
 
double Amount (Composition::Ptr c)
 
double atom_frac (Nuc nuc)
 
double atom_frac (std::string nuc)
 
double mass (Nuc nuc)
 
double mass (std::string nuc)
 
double mass_frac (Nuc nuc)
 
double mass_frac (std::string nuc)
 
double mass_frac (std::set< Nuc > nucs)
 
 MatQuery (Material::Ptr m)
 
double moles (Nuc nuc)
 
double moles (std::string nuc)
 
double qty ()
 

Constructor & Destructor Documentation

cyclus::toolkit::MatQuery::MatQuery ( Material::Ptr  m)

Creates a new query object inspecting m.

Definition at line 9 of file mat_query.cc.

Member Function Documentation

bool cyclus::toolkit::MatQuery::AlmostEq ( Material::Ptr  other,
double  threshold = eps_rsrc() 
)

Returns true if all nuclide fractions of the material and other are the same within threshold.

Definition at line 60 of file mat_query.cc.

double cyclus::toolkit::MatQuery::Amount ( Composition::Ptr  c)

Returns the maximum mass quantity of composition c that can be extracted from the material.

Definition at line 68 of file mat_query.cc.

double cyclus::toolkit::MatQuery::atom_frac ( Nuc  nuc)

returns the atom/mole fraction of nuclide nuc in the material.

Definition at line 38 of file mat_query.cc.

double cyclus::toolkit::MatQuery::atom_frac ( std::string  nuc)

returns the atom/mole fraction of nuclide nuc in the material.

Definition at line 56 of file mat_query.cc.

double cyclus::toolkit::MatQuery::mass ( Nuc  nuc)

Returns the mass in kg of nuclide nuc in the material.

Definition at line 15 of file mat_query.cc.

double cyclus::toolkit::MatQuery::mass ( std::string  nuc)

Returns the mass in kg of nuclide nuc in the material.

Definition at line 44 of file mat_query.cc.

double cyclus::toolkit::MatQuery::mass_frac ( Nuc  nuc)

Returns the mass fraction of nuclide nuc in the material.

Definition at line 23 of file mat_query.cc.

double cyclus::toolkit::MatQuery::mass_frac ( std::string  nuc)

Returns the mass fraction of nuclide nuc in the material.

Definition at line 52 of file mat_query.cc.

double cyclus::toolkit::MatQuery::mass_frac ( std::set< Nuc nucs)

Returns the combined mass fraction of the set of nuclides nuc in the material.

Definition at line 29 of file mat_query.cc.

double cyclus::toolkit::MatQuery::moles ( Nuc  nuc)

Returns the number of moles of nuclide nuc in the material.

Definition at line 19 of file mat_query.cc.

double cyclus::toolkit::MatQuery::moles ( std::string  nuc)

Returns the number of moles of nuclide nuc in the material.

Definition at line 48 of file mat_query.cc.

double cyclus::toolkit::MatQuery::qty ( )

Returns the mass in kg of the material.

Definition at line 11 of file mat_query.cc.


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