GRINS::ParameterAntiochReset Class Reference

#include <parameter_antioch_reset.h>

Inheritance diagram for GRINS::ParameterAntiochReset:

Collaboration diagram for GRINS::ParameterAntiochReset:

Public Member Functions
	ParameterAntiochReset ()
	ParameterAntiochReset (Antioch::ReactionSet< libMesh::Real > &reaction_set, const std::string &param_name)
virtual ParameterAccessor< libMesh::Number > &	operator= (libMesh::Number *)
virtual void	set (const libMesh::Number &new_value)
virtual const libMesh::Number &	get () const
void	push_back (Antioch::ReactionSet< libMesh::Real > &new_reaction_set)
std::size_t	size () const
virtual libMesh::UniquePtr< ParameterAccessor< libMesh::Number > >	clone () const

Private Attributes
std::string	_reaction_id
std::vector< std::string >	_keywords
std::vector< Antioch::ReactionSet< libMesh::Number > * >	_reaction_sets
libMesh::Number	_current_val

Detailed Description

Accessor object allowing reading and modification of Antioch Kinetics variables in a parameter sensitivity calculation.

Definition at line 46 of file parameter_antioch_reset.h.

Constructor & Destructor Documentation

GRINS::ParameterAntiochReset::ParameterAntiochReset

(

)

Constructor: no parameters attached yet

Definition at line 36 of file parameter_antioch_reset.C.

Referenced by clone().

{}

GRINS::ParameterAntiochReset::ParameterAntiochReset	(	Antioch::ReactionSet< libMesh::Real > &	reaction_set,
		const std::string &	param_name
	)

Constructor: take the first raw pointer to the parameter

Definition at line 40 of file parameter_antioch_reset.C.

                                 :
    _reaction_sets(1, &reaction_set)
  {
    std::stringstream stream(param_name);
    std::string keyword;

    std::getline(stream, keyword, '/');
    libmesh_assert(!stream.fail());
    libmesh_assert_equal_to(keyword, "Antioch");

    std::getline(stream, keyword, '/');
    libmesh_assert(!stream.fail());
    _reaction_id = keyword;

    while (std::getline(stream, keyword, '/')) {
      _keywords.push_back(keyword);
    }

    libmesh_assert_greater (_keywords.size(), 0);
  }

Member Function Documentation

virtual libMesh::UniquePtr<ParameterAccessor<libMesh::Number> > GRINS::ParameterAntiochReset::clone ( ) const

inlinevirtual

Returns a new copy of the accessor.

Definition at line 91 of file parameter_antioch_reset.h.

References ParameterAntiochReset().

                                                                              {
      // Default shallow copy works for this class
      ParameterAntiochReset *par = new ParameterAntiochReset(*this);

      return libMesh::UniquePtr<ParameterAccessor<libMesh::Number> >(par);
    }

const libMesh::Number & GRINS::ParameterAntiochReset::get ( ) const

virtual

Getter: get the value of the parameter we access.

Definition at line 93 of file parameter_antioch_reset.C.

References _current_val, _keywords, _reaction_id, and _reaction_sets.

  {
    libmesh_assert(!_reaction_sets.empty());
    _current_val =
      _reaction_sets[0]->get_parameter_of_reaction
      (_reaction_id, _keywords);
#ifndef NDEBUG
    // If you're already using inconsistent parameters we can't help
    // you.
    for (unsigned int i=1; i < _reaction_sets.size(); ++i)
      libmesh_assert_equal_to
        (_current_val, _reaction_sets[i]->get_parameter_of_reaction
         (_reaction_id, _keywords));
#endif
    return _current_val;
  }

virtual ParameterAccessor<libMesh::Number>& GRINS::ParameterAntiochReset::operator= ( libMesh::Number *  )

inlinevirtual

A simple reseater won't work with a getter/setter

Definition at line 66 of file parameter_antioch_reset.h.

{ libmesh_error(); return *this; }

void GRINS::ParameterAntiochReset::push_back ( Antioch::ReactionSet< libMesh::Real > &  new_reaction_set )

inline

Definition at line 79 of file parameter_antioch_reset.h.

References _reaction_sets.

    { _reaction_sets.push_back(&new_reaction_set); }

void GRINS::ParameterAntiochReset::set ( const libMesh::Number &  new_value )

virtual

Setter: change the value of the parameter we access.

Definition at line 67 of file parameter_antioch_reset.C.

References _keywords, _reaction_id, and _reaction_sets.

  {
    libmesh_assert(!_reaction_sets.empty());
#ifndef NDEBUG
    libMesh::Number val =
      _reaction_sets[0]->get_parameter_of_reaction
      (_reaction_id, _keywords);
#endif
    for (unsigned int i=0; i != _reaction_sets.size(); ++i)
      {
        // If you're already using inconsistent parameters we can't
        // help you.
        libmesh_assert_equal_to
          (val,
           _reaction_sets[i]->get_parameter_of_reaction
           (_reaction_id, _keywords));
        _reaction_sets[i]->set_parameter_of_reaction
          (_reaction_id, _keywords, new_value);
      }
  }

std::size_t GRINS::ParameterAntiochReset::size ( ) const

inline

Returns the number of data associated with this parameter. Useful for testing if the resetter is empty/invalid.

Definition at line 86 of file parameter_antioch_reset.h.

References _reaction_sets.

{ return _reaction_sets.size(); }

Member Data Documentation

libMesh::Number GRINS::ParameterAntiochReset::_current_val

mutableprivate

Definition at line 111 of file parameter_antioch_reset.h.

Referenced by get().

std::vector<std::string> GRINS::ParameterAntiochReset::_keywords

private

Definition at line 102 of file parameter_antioch_reset.h.

Referenced by get(), and set().

std::string GRINS::ParameterAntiochReset::_reaction_id

private

Definition at line 101 of file parameter_antioch_reset.h.

Referenced by get(), and set().

std::vector<Antioch::ReactionSet<libMesh::Number> *> GRINS::ParameterAntiochReset::_reaction_sets

private

Definition at line 106 of file parameter_antioch_reset.h.

Referenced by get(), push_back(), set(), and size().

---

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

• src/utilities/include/grins/parameter_antioch_reset.h
• src/utilities/src/parameter_antioch_reset.C