ryujin::TaskComposition< dim, Number > Struct Template Reference

#include <include/ryujin/driver/task_composition.h>

Collaboration diagram for ryujin::TaskComposition< dim, Number >:

Public Member Functions
	TaskComposition (Interface::Simulation< dim, Number > &simulation)
void	run ()

Public Attributes
Interface::Simulation< dim, Number > &	simulation
VTUOutput< dim, Number >	vtu_output
VTUOutput< dim, Number >	vtu_levelsets
Quantities< dim, Number >	quantities
ErrorEvaluation< dim, Number >	error_evaluation
MeshAdaptor< dim, Number >	mesh_adaptor
Logger< dim, Number >	logger
Checkpointing< dim, Number >	checkpointing
Scheduler< Number >	scheduler

Detailed Description

template<int dim, typename Number = double>
struct ryujin::TaskComposition< dim, Number >

A TaskComposition assembles the library tasks and the Scheduler around a Simulation. The tasks are constructed (and declare their run time parameters) in the order of the subsections "/I - VTUOutput" to "/N - Checkpointing", which is the order of their phases in a cycle.

The Simulation and the Logger are required tasks; all other tasks are selected with the run time parameter "tasks" of the Scheduler.

Note

This class sets up the default simulation chain of tasks used in ryujin for any given Equation.

Definition at line 35 of file task_composition.h.

Constructor & Destructor Documentation

TaskComposition()

template<int dim, typename Number = double>

ryujin::TaskComposition< dim, Number >::TaskComposition ( Interface::Simulation< dim, Number > &  simulation )

inline

Constructor taking the Simulation the tasks work with.

Definition at line 39 of file task_composition.h.

References ryujin::TaskComposition< dim, Number >::logger, and ryujin::TaskComposition< dim, Number >::simulation.

Member Function Documentation

run()

template<int dim, typename Number = double>

void ryujin::TaskComposition< dim, Number >::run ( )

inline

Run the simulation.

Definition at line 63 of file task_composition.h.

References ryujin::TaskComposition< dim, Number >::scheduler.

Member Data Documentation

simulation

template<int dim, typename Number = double>

Interface::Simulation<dim, Number>& ryujin::TaskComposition< dim, Number >::simulation

Definition at line 68 of file task_composition.h.

Referenced by ryujin::TaskComposition< dim, Number >::TaskComposition().

vtu_output

template<int dim, typename Number = double>

VTUOutput<dim, Number> ryujin::TaskComposition< dim, Number >::vtu_output

Definition at line 70 of file task_composition.h.

vtu_levelsets

template<int dim, typename Number = double>

VTUOutput<dim, Number> ryujin::TaskComposition< dim, Number >::vtu_levelsets

Definition at line 71 of file task_composition.h.

quantities

template<int dim, typename Number = double>

Quantities<dim, Number> ryujin::TaskComposition< dim, Number >::quantities

Definition at line 72 of file task_composition.h.

error_evaluation

template<int dim, typename Number = double>

ErrorEvaluation<dim, Number> ryujin::TaskComposition< dim, Number >::error_evaluation

Definition at line 73 of file task_composition.h.

mesh_adaptor

template<int dim, typename Number = double>

MeshAdaptor<dim, Number> ryujin::TaskComposition< dim, Number >::mesh_adaptor

Definition at line 74 of file task_composition.h.

logger

template<int dim, typename Number = double>

Logger<dim, Number> ryujin::TaskComposition< dim, Number >::logger

Definition at line 75 of file task_composition.h.

Referenced by ryujin::TaskComposition< dim, Number >::TaskComposition().

checkpointing

template<int dim, typename Number = double>

Checkpointing<dim, Number> ryujin::TaskComposition< dim, Number >::checkpointing

Definition at line 76 of file task_composition.h.

scheduler

template<int dim, typename Number = double>

Scheduler<Number> ryujin::TaskComposition< dim, Number >::scheduler

Definition at line 78 of file task_composition.h.

Referenced by ryujin::TaskComposition< dim, Number >::run().

---

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

• include/ryujin/driver/task_composition.h