https://mooseframework.inl.gov
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SimpleTurbinePowerAuxTempl< T > Class Template Reference

Computes turbine power for 1-phase flow. More...

#include <SimpleTurbinePowerAux.h>

Inheritance diagram for SimpleTurbinePowerAuxTempl< T >:
[legend]

Public Member Functions

 SimpleTurbinePowerAuxTempl (const InputParameters &parameters)
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual Real computeValue () override
 

Protected Attributes

const bool & _on
 Flag indicating if turbine is operating or not. More...
 

Detailed Description

template<typename T>
class SimpleTurbinePowerAuxTempl< T >

Computes turbine power for 1-phase flow.

Definition at line 21 of file SimpleTurbinePowerAux.h.

Constructor & Destructor Documentation

◆ SimpleTurbinePowerAuxTempl()

template<typename T >
SimpleTurbinePowerAuxTempl< T >::SimpleTurbinePowerAuxTempl ( const InputParameters parameters)

Definition at line 31 of file SimpleTurbinePowerAux.C.

32  : T(parameters), _on(this->template getParam<bool>("on"))
33 {
34 }
const bool & _on
Flag indicating if turbine is operating or not.

Member Function Documentation

◆ computeValue()

template<typename T >
Real SimpleTurbinePowerAuxTempl< T >::computeValue ( )
overrideprotectedvirtual

Definition at line 38 of file SimpleTurbinePowerAux.C.

39 {
40  if (_on)
41  return this->_value;
42  else
43  return 0.;
44 }
const bool & _on
Flag indicating if turbine is operating or not.

◆ validParams()

template<typename T >
InputParameters SimpleTurbinePowerAuxTempl< T >::validParams ( )
static

Definition at line 21 of file SimpleTurbinePowerAux.C.

22 {
24  params.addRequiredParam<bool>("on", "Flag determining if turbine is operating or not");
25  params.addClassDescription("Computes turbine power for 1-phase flow for a simple on/off turbine");
26  params.declareControllable("on");
27  return params;
28 }
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters validParams()
void addClassDescription(const std::string &doc_string)
void declareControllable(const std::string &name, std::set< ExecFlagType > execute_flags={})

Member Data Documentation

◆ _on

template<typename T >
const bool& SimpleTurbinePowerAuxTempl< T >::_on
protected

Flag indicating if turbine is operating or not.

Definition at line 30 of file SimpleTurbinePowerAux.h.


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