Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | List of all members
MultipleParameterLoop::UserClass Class Referenceabstract

#include <parameter_handler.h>

Public Member Functions

virtual ~UserClass ()
 
virtual void create_new (const unsigned int run_no)=0
 
virtual void declare_parameters (ParameterHandler &prm)=0
 
virtual void run (ParameterHandler &prm)=0
 

Detailed Description

This is the class the helper class or the problem class has to be derived of.

Definition at line 2209 of file parameter_handler.h.

Constructor & Destructor Documentation

virtual MultipleParameterLoop::UserClass::~UserClass ( )
virtual

Destructor. It doesn't actually do anything, but is declared to force derived classes to have a virtual destructor.

Member Function Documentation

virtual void MultipleParameterLoop::UserClass::create_new ( const unsigned int  run_no)
pure virtual

create_new must provide a clean object, either by creating a new one or by cleaning an old one.

virtual void MultipleParameterLoop::UserClass::declare_parameters ( ParameterHandler prm)
pure virtual

This should declare parameters and call the declare_parameters function of the problem class.

virtual void MultipleParameterLoop::UserClass::run ( ParameterHandler prm)
pure virtual

Get the parameters and run any necessary action.


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