LCOV - code coverage report
Current view: top level - include/controls - SamplerReceiver.h (source / functions) Hit Total Coverage
Test: stochastic_tools Test Coverage Lines: 1 1 100.0 %
Date: 2017-11-18 13:35:36 Functions: 2 2 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /****************************************************************/
       2             : /*               DO NOT MODIFY THIS HEADER                      */
       3             : /* MOOSE - Multiphysics Object Oriented Simulation Environment  */
       4             : /*                                                              */
       5             : /*           (c) 2010 Battelle Energy Alliance, LLC             */
       6             : /*                   ALL RIGHTS RESERVED                        */
       7             : /*                                                              */
       8             : /*          Prepared by Battelle Energy Alliance, LLC           */
       9             : /*            Under Contract No. DE-AC07-05ID14517              */
      10             : /*            With the U. S. Department of Energy               */
      11             : /*                                                              */
      12             : /*            See COPYRIGHT for full restrictions               */
      13             : /****************************************************************/
      14             : 
      15             : #ifndef SAMPLERRECEIVER_H
      16             : #define SAMPLERRECEIVER_H
      17             : 
      18             : // MOOSE includes
      19             : #include "Control.h"
      20             : 
      21             : // Forward declarations
      22             : class SamplerReceiver;
      23             : class Function;
      24             : 
      25             : template <>
      26             : InputParameters validParams<SamplerReceiver>();
      27             : 
      28             : /**
      29             :  * A Control object for receiving data from a master application Sampler object.
      30             :  */
      31         138 : class SamplerReceiver : public Control
      32             : {
      33             : public:
      34             :   SamplerReceiver(const InputParameters & parameters);
      35             :   virtual void execute() override;
      36             : 
      37             : protected:
      38             :   /**
      39             :    * Clears the list of parameters to modify
      40             :    */
      41             :   void reset();
      42             : 
      43             :   /**
      44             :    * Appends the list of parameters to modify
      45             :    */
      46             :   void addControlParameter(const std::string & name, const Real & value);
      47             : 
      48             :   /// Storage for the parameters to control
      49             :   std::map<std::string, Real> _parameters;
      50             : 
      51             :   /// Allows the SamplerTransfer to call the reset and addControlParameter methods, which
      52             :   /// should only be called by that object so making the public is dangerous.
      53             :   friend class SamplerTransfer;
      54             : };
      55             : 
      56             : #endif

Generated by: LCOV version 1.11