User facing host object for a function. This combines a term with an argument list. More...

#include <ExpressionBuilder.h>

Public Member Functions
	EBFunction ()

	operator EBTerm () const
	cast an EBFunction into an EBTerm

	operator std::string () const
	cast into a string (via the cast into a term above)

std::string	args ()
	get the list of arguments and check if they are all symbols

unsigned int	substitute (const EBSubstitutionRule &rule)

unsigned int	substitute (const EBSubstitutionRuleList &rules)


EBFunction &	operator() (const EBTerm &arg)

EBFunction &	operator() (const EBTermList &args)


EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2)

EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2, const EBTerm &a3)

EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2, const EBTerm &a3, const EBTerm &a4)

EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2, const EBTerm &a3, const EBTerm &a4, const EBTerm &a5)

EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2, const EBTerm &a3, const EBTerm &a4, const EBTerm &a5, const EBTerm &a6)

EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2, const EBTerm &a3, const EBTerm &a4, const EBTerm &a5, const EBTerm &a6, const EBTerm &a7)

EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2, const EBTerm &a3, const EBTerm &a4, const EBTerm &a5, const EBTerm &a6, const EBTerm &a7, const EBTerm &a8)

EBFunction &	operator() (const EBTerm &a1, const EBTerm &a2, const EBTerm &a3, const EBTerm &a4, const EBTerm &a5, const EBTerm &a6, const EBTerm &a7, const EBTerm &a8, const EBTerm &a9)


EBFunction &	operator= (const EBTerm &)

EBFunction &	operator= (const EBFunction &)


EBTerm	operator- ()

EBTerm	operator! ()

Protected Attributes
EBTermList	_arguments
	argument list the function is declared with

EBTermList	_eval_arguments
	argument list passed in when evaluating the function

EBTerm	_term

Detailed Description

User facing host object for a function. This combines a term with an argument list.

Definition at line 537 of file ExpressionBuilder.h.

Constructor & Destructor Documentation

◆ EBFunction()

ExpressionBuilder::EBFunction::EBFunction ( )

inline

Definition at line 540 of file ExpressionBuilder.h.

540{}

Member Function Documentation

◆ args()

std::string ExpressionBuilder::EBFunction::args ( )

get the list of arguments and check if they are all symbols

Definition at line 217 of file ExpressionBuilder.C.

{
  unsigned int narg = _arguments.size();
  if (narg < 1)
    return "";
 
  std::ostringstream s;
  s << _arguments[0];
  for (unsigned int i = 1; i < narg; ++i)
    s << ',' << _arguments[i];
 
  return s.str();
}

◆ operator EBTerm()

ExpressionBuilder::EBFunction::operator EBTerm ( ) const

cast an EBFunction into an EBTerm

◆ operator std::string()

ExpressionBuilder::EBFunction::operator std::string ( ) const

cast into a string (via the cast into a term above)

Definition at line 207 of file ExpressionBuilder.C.

{
  EBTerm eval;
  eval = *this; // typecast EBFunction -> EBTerm performs a parameter substitution
  std::ostringstream s;
  s << eval;
  return s.str();
}

◆ operator!()

EBTerm ExpressionBuilder::EBFunction::operator! ( )

inline

Definition at line 631 of file ExpressionBuilder.h.

631{ return !EBTerm(*this); }

◆ operator()() [1/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2
	)

inline

convenience operators to allow single bracket syntax

Definition at line 551 of file ExpressionBuilder.h.

551{ return (*this)((a1, a2)); }

◆ operator()() [2/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2,
		const EBTerm &	a3
	)

inline

Definition at line 552 of file ExpressionBuilder.h.

    {
      return (*this)((a1, a2, a3));
    }

◆ operator()() [3/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2,
		const EBTerm &	a3,
		const EBTerm &	a4
	)

inline

Definition at line 557 of file ExpressionBuilder.h.

    {
      return (*this)((a1, a2, a3, a4));
    }

◆ operator()() [4/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2,
		const EBTerm &	a3,
		const EBTerm &	a4,
		const EBTerm &	a5
	)

inline

Definition at line 561 of file ExpressionBuilder.h.

    {
      return (*this)((a1, a2, a3, a4, a5));
    }

◆ operator()() [5/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2,
		const EBTerm &	a3,
		const EBTerm &	a4,
		const EBTerm &	a5,
		const EBTerm &	a6
	)

inline

Definition at line 569 of file ExpressionBuilder.h.

    {
      return (*this)((a1, a2, a3, a4, a5, a6));
    }

◆ operator()() [6/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2,
		const EBTerm &	a3,
		const EBTerm &	a4,
		const EBTerm &	a5,
		const EBTerm &	a6,
		const EBTerm &	a7
	)

inline

Definition at line 578 of file ExpressionBuilder.h.

    {
      return (*this)((a1, a2, a3, a4, a5, a6, a7));
    }

◆ operator()() [7/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2,
		const EBTerm &	a3,
		const EBTerm &	a4,
		const EBTerm &	a5,
		const EBTerm &	a6,
		const EBTerm &	a7,
		const EBTerm &	a8
	)

inline

Definition at line 588 of file ExpressionBuilder.h.

    {
      return (*this)((a1, a2, a3, a4, a5, a6, a7, a8));
    }

◆ operator()() [8/10]

EBFunction & ExpressionBuilder::EBFunction::operator()	(	const EBTerm &	a1,
		const EBTerm &	a2,
		const EBTerm &	a3,
		const EBTerm &	a4,
		const EBTerm &	a5,
		const EBTerm &	a6,
		const EBTerm &	a7,
		const EBTerm &	a8,
		const EBTerm &	a9
	)

inline

Definition at line 599 of file ExpressionBuilder.h.

    {
      return (*this)((a1, a2, a3, a4, a5, a6, a7, a8, a9));
    }

◆ operator()() [9/10]

ExpressionBuilder::EBFunction & ExpressionBuilder::EBFunction::operator() ( const EBTerm & arg )

set the temporary argument list which is either used for evaluation or committed to the argument list upon function definition (assignment)

Definition at line 154 of file ExpressionBuilder.C.

{
  this->_eval_arguments = {arg};
  return *this;
}

◆ operator()() [10/10]

ExpressionBuilder::EBFunction & ExpressionBuilder::EBFunction::operator() ( const EBTermList & args )

Definition at line 161 of file ExpressionBuilder.C.

{
  this->_eval_arguments = EBTermList(args);
  return *this;
}

◆ operator-()

EBTerm ExpressionBuilder::EBFunction::operator- ( )

inline

Unary operators on functions

Definition at line 630 of file ExpressionBuilder.h.

630{ return -EBTerm(*this); }

◆ operator=() [1/2]

ExpressionBuilder::EBFunction & ExpressionBuilder::EBFunction::operator= ( const EBFunction & func )

Definition at line 176 of file ExpressionBuilder.C.

{
  this->_arguments = this->_eval_arguments;
  this->_term = EBTerm(func);
  return *this;
}

◆ operator=() [2/2]

ExpressionBuilder::EBFunction & ExpressionBuilder::EBFunction::operator= ( const EBTerm & term )

function definition (assignment)

Definition at line 168 of file ExpressionBuilder.C.

{
  this->_arguments = this->_eval_arguments;
  this->_term = term;
  return *this;
}

◆ substitute() [1/2]

unsigned int ExpressionBuilder::EBFunction::substitute ( const EBSubstitutionRule & rule )

Definition at line 232 of file ExpressionBuilder.C.

{
  return _term.substitute(rule);
}

Referenced by RegularSolutionFreeEnergy::RegularSolutionFreeEnergy().

◆ substitute() [2/2]

unsigned int ExpressionBuilder::EBFunction::substitute ( const EBSubstitutionRuleList & rules )

Definition at line 238 of file ExpressionBuilder.C.

{
  return _term.substitute(rules);
}

Member Data Documentation

◆ _arguments

EBTermList ExpressionBuilder::EBFunction::_arguments

protected

argument list the function is declared with

Definition at line 640 of file ExpressionBuilder.h.

◆ _eval_arguments

EBTermList ExpressionBuilder::EBFunction::_eval_arguments

protected

argument list passed in when evaluating the function

Definition at line 642 of file ExpressionBuilder.h.

◆ _term

EBTerm ExpressionBuilder::EBFunction::_term

protected

Definition at line 645 of file ExpressionBuilder.h.

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

phase_field/include/utils/ExpressionBuilder.h
phase_field/src/utils/ExpressionBuilder.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EBFunction()

Member Function Documentation

◆ args()

◆ operator EBTerm()

◆ operator std::string()

◆ operator!()

◆ operator()() [1/10]

◆ operator()() [2/10]

◆ operator()() [3/10]

◆ operator()() [4/10]

◆ operator()() [5/10]

◆ operator()() [6/10]

◆ operator()() [7/10]

◆ operator()() [8/10]

◆ operator()() [9/10]

◆ operator()() [10/10]

◆ operator-()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ substitute() [1/2]

◆ substitute() [2/2]

Member Data Documentation

◆ _arguments

◆ _eval_arguments

◆ _term