hummingbird::ParsedVolumetricSource Class Reference

Defines a volumetric source defined by a parsed function passed by the user. More...

#include <parsed_volumetric_source.h>

Inheritance diagram for hummingbird::ParsedVolumetricSource:

Collaboration diagram for hummingbird::ParsedVolumetricSource:

Public Member Functions
	ParsedVolumetricSource (const std::string expression)
	Construct a new Parsed Volumetric Source object.
double	EvaluateAtNode (const Node &node, const Ordinate &ordinate) override
	Evaluate the parsed expression_ at a node in a particular direction. The expression may reference the variables x, y, z (the node's coordinates) and mu (the direction's x-direction cosine).
Public Member Functions inherited from hummingbird::SourceBase
	SourceBase ()=default
	Construct a new Source Base object.
virtual	~SourceBase ()=default
	Destroy the Source Base object.

Private Attributes
const std::string	expression_
	Function expression to be evaluated.

Detailed Description

Defines a volumetric source defined by a parsed function passed by the user.

Definition at line 19 of file parsed_volumetric_source.h.

Constructor & Destructor Documentation

ParsedVolumetricSource()

hummingbird::ParsedVolumetricSource::ParsedVolumetricSource

(

const std::string

expression

)

Construct a new Parsed Volumetric Source object.

Parameters

expression

Function expression to be evaluated

Definition at line 8 of file parsed_volumetric_source.cc.

Member Function Documentation

EvaluateAtNode()

double hummingbird::ParsedVolumetricSource::EvaluateAtNode ( const Node & node, const Ordinate & ordinate )

overridevirtual

Evaluate the parsed expression_ at a node in a particular direction. The expression may reference the variables x, y, z (the node's coordinates) and mu (the direction's x-direction cosine).

Parameters

node	Node
ordinate	Ordinate (direction)

Returns

Volumetric source in n/cm2/s/str

Exceptions

std::runtime_error

if the expression fails to parse

Todo

Add support for 2- and 3D angular functions (currently only supports mu-functions).

Implements hummingbird::SourceBase.

Definition at line 11 of file parsed_volumetric_source.cc.

Member Data Documentation

expression_

const std::string hummingbird::ParsedVolumetricSource::expression_

private

Function expression to be evaluated.

Definition at line 44 of file parsed_volumetric_source.h.

---

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

• /home/runner/work/hummingbird/hummingbird/include/physics/parsed_volumetric_source.h
• /home/runner/work/hummingbird/hummingbird/src/physics/parsed_volumetric_source.cc