GRINS::ParsedPropertyBase Class Reference

Base class for material properties based on ParsedFunction. More...

#include <parsed_property_base.h>

Inheritance diagram for GRINS::ParsedPropertyBase:

Collaboration diagram for GRINS::ParsedPropertyBase:

Public Member Functions
	ParsedPropertyBase ()
virtual	~ParsedPropertyBase ()
libMesh::Real	operator() (AssemblyContext &context, unsigned int qp) const
libMesh::Real	operator() (const libMesh::Point &p, const libMesh::Real time)
virtual void	init (libMesh::FEMSystem *)

Protected Member Functions
bool	check_func_nonzero (const std::string &function) const
	Returns true if function string is nonzero. More...

Protected Attributes
libMesh::ParsedFunction< libMesh::Number >	_func

Detailed Description

Base class for material properties based on ParsedFunction.

This class contains the basic interface and functionality. Subclasses should only need to handle the parsing of the function-string and create the ParsedFunction in the local _func variable.

Definition at line 47 of file parsed_property_base.h.

Constructor & Destructor Documentation

GRINS::ParsedPropertyBase::ParsedPropertyBase ( )

inline

Definition at line 51 of file parsed_property_base.h.

: _func("") {};

virtual GRINS::ParsedPropertyBase::~ParsedPropertyBase ( )

inlinevirtual

Definition at line 52 of file parsed_property_base.h.

{};

Member Function Documentation

bool GRINS::ParsedPropertyBase::check_func_nonzero ( const std::string &  function ) const

protected

Returns true if function string is nonzero.

The ParsedFunction used is built through a string argument. This function checks if the string is "0". This is useful for cases where the function must not be zero.

Definition at line 30 of file parsed_property_base.C.

Referenced by GRINS::ParsedConductivity::ParsedConductivity(), and GRINS::ParsedViscosity::ParsedViscosity().

  {
    bool is_nonzero = true;

    if (function == std::string("0"))
      {
        is_nonzero = false;
      }

    return is_nonzero;
  }

virtual void GRINS::ParsedPropertyBase::init ( libMesh::FEMSystem *  )

inlinevirtual

Definition at line 58 of file parsed_property_base.h.

{};

libMesh::Real GRINS::ParsedPropertyBase::operator() ( AssemblyContext &  context, unsigned int  qp  ) const

inline

Definition at line 75 of file parsed_property_base.h.

References _func.

  {
    // FIXME: We should be getting the variable index to get the qps from the context
    // not hardcode it to be 0
    const std::vector<libMesh::Point>& x = context.get_element_fe(0)->get_xyz();

    const libMesh::Point& x_qp = x[qp];

    // libMesh API here sucks - RHS
    libMesh::ParsedFunction<libMesh::Number> & mutable_func =
      const_cast<libMesh::ParsedFunction<libMesh::Number> &>(_func);
    libMesh::Number value = mutable_func(x_qp,context.time);

    return value;
  }

libMesh::Real GRINS::ParsedPropertyBase::operator() ( const libMesh::Point &  p, const libMesh::Real  time  )

inline

Definition at line 92 of file parsed_property_base.h.

References _func.

  {
    return _func(p,time);
  }

Member Data Documentation

libMesh::ParsedFunction<libMesh::Number> GRINS::ParsedPropertyBase::_func

protected

Definition at line 69 of file parsed_property_base.h.

Referenced by operator()(), GRINS::ParsedConductivity::ParsedConductivity(), and GRINS::ParsedViscosity::ParsedViscosity().

---

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

• src/properties/include/grins/parsed_property_base.h
• src/properties/src/parsed_property_base.C