FunctionSeriesToAux.h File Reference

Go to the source code of this file.

Classes
class	FunctionSeriesToAux
	Specialization of FunctionAux that is designed to work specifically with FXs, namely that it is always processed at timestep_begin. More...

Functions
template<>
InputParameters	validParams< FunctionSeriesToAux > ()

Function Documentation

validParams< FunctionSeriesToAux >()

template<>

InputParameters validParams< FunctionSeriesToAux >

(

)

Definition at line 17 of file FunctionSeriesToAux.C.

{
  InputParameters params = validParams<FunctionAux>();
 
  params.addClassDescription("AuxKernel to convert a functional expansion"
                             " (Functions object, type = FunctionSeries) to an AuxVariable");
 
  // Force this AuxKernel to execute at "timestep_begin"
  params.set<ExecFlagEnum>("execute_on", true) = EXEC_TIMESTEP_BEGIN;
  // Don't let the user change the execution time
  params.suppressParameter<ExecFlagEnum>("execute_on");
 
  return params;
}