Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions

DataOutRotation< dim, DH > Class Template Reference
[Graphical output]

Inheritance diagram for DataOutRotation< dim, DH >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef DataOut_DoFData< DH,
DH::dimension+1 >
::cell_iterator 
cell_iterator

Public Member Functions

virtual void build_patches (const unsigned int n_patches_per_circle, const unsigned int n_subdivisions=0)
virtual cell_iterator first_cell ()
virtual cell_iterator next_cell (const cell_iterator &cell)

Static Public Member Functions

::ExceptionBaseExcInvalidNumberOfSubdivisions (int arg1) throw (errortext << "The number of subdivisions per patch, " << arg1 << ", is not valid." )
::ExceptionBaseExcRadialVariableHasNegativeValues (double arg1) throw (errortext << "The radial variable attains a negative value of " << arg1 )

Private Member Functions

void build_one_patch (const cell_iterator *cell, internal::DataOutRotation::ParallelData< DH::dimension, DH::space_dimension > &data, std::vector< DataOutBase::Patch< DH::dimension+1, DH::space_dimension+1 > > &patches)

Detailed Description

template<int dim, class DH = DoFHandler<dim>>
class DataOutRotation< dim, DH >

This class generates output in the full domain of computations that were done using rotational symmetry of domain and solution. In particular, if a computation of a three dimensional problem with rotational symmetry around the z-axis (i.e. in the r-z-plane) was done, then this class can be used to generate the output in the original x-y-z space. In order to do so, it generates from each cell in the computational mesh a cell in the space with dimension one greater than that of the DoFHandler object. The resulting output will then consist of hexahedra forming an object that has rotational symmetry around the z-axis. As most graphical programs can not represent ring-like structures, the angular (rotation) variable is discretized into a finite number of intervals as well; the number of these intervals must be given to the build_patches function. It is noted, however, that while this function generates nice pictures of the whole domain, it often produces very large output files.

Interface

The interface of this class is copied from the DataOut class. Furthermore, they share the common parent class DataOut_DoFData(). See the reference of these two classes for a discussion of the interface and how to extend it by deriving further classes from this class.

Details for 1d computations

The one coordinate in the triangulation used by the DoFHandler object passed to this class is taken as the radial variable, and the output will then be either a circle or a ring domain. It is in the user's responsibility to assure that the radial coordinate only attains non-negative values.

Details for 2d computations

We consider the computation (represented by the DoFHandler object that is attached to this class) to have happened in the r-z-plane, where r is the radial variable and z denotes the axis of revolution around which the solution is symmetric. The output is in x-y-z space, where the radial dependence is transformed to the x-y plane. At present, it is not possible to exchange the meaning of the first and second variable of the plane in which the simulation was made, i.e. generate output from a simulation where the first variable denoted the symmetry axis, and the second denoted the radial variable. You have to take that into account when first programming your application.

It is in the responsibility of the user to make sure that the radial variable attains only non-negative values.

Author:
Wolfgang Bangerth, 2000

Definition at line 121 of file data_out_rotation.h.


Member Typedef Documentation

template<int dim, class DH = DoFHandler<dim>>
typedef DataOut_DoFData<DH,DH::dimension+1>::cell_iterator DataOutRotation< dim, DH >::cell_iterator

Typedef to the iterator type of the dof handler class under consideration.

Reimplemented from DataOut_DoFData< DH, DH::dimension+1 >.

Definition at line 129 of file data_out_rotation.h.


Member Function Documentation

template<int dim, class DH = DoFHandler<dim>>
virtual void DataOutRotation< dim, DH >::build_patches ( const unsigned int  n_patches_per_circle,
const unsigned int  n_subdivisions = 0 
) [virtual]

This is the central function of this class since it builds the list of patches to be written by the low-level functions of the base class. See the general documentation of this class for further information.

In addition to the same parameters as found in the respective function of the DataOut class, the first parameter denotes into how many intervals the angular (rotation) variable is to be subdivided.

The function supports multithreading, if deal.II is compiled in multithreading mode. The default number of threads to be used to build the patches is set to multithread_info.n_default_threads.

template<int dim, class DH = DoFHandler<dim>>
virtual cell_iterator DataOutRotation< dim, DH >::first_cell (  ) [virtual]

Return the first cell which we want output for. The default implementation returns the first active cell, but you might want to return other cells in a derived class.

template<int dim, class DH = DoFHandler<dim>>
virtual cell_iterator DataOutRotation< dim, DH >::next_cell ( const cell_iterator cell ) [virtual]

Return the next cell after cell which we want output for. If there are no more cells, dofs->end() shall be returned.

The default implementation returns the next active cell, but you might want to return other cells in a derived class. Note that the default implementation assumes that the given cell is active, which is guaranteed as long as first_cell is also used from the default implementation. Overloading only one of the two functions might not be a good idea.

template<int dim, class DH = DoFHandler<dim>>
::ExceptionBase& DataOutRotation< dim, DH >::ExcInvalidNumberOfSubdivisions ( int  arg1 ) throw (errortext << "The number of subdivisions per patch, " << arg1 << ", is not valid." ) [static]

Exception

template<int dim, class DH = DoFHandler<dim>>
::ExceptionBase& DataOutRotation< dim, DH >::ExcRadialVariableHasNegativeValues ( double  arg1 ) throw (errortext << "The radial variable attains a negative value of " << arg1 ) [static]

Exception

template<int dim, class DH = DoFHandler<dim>>
void DataOutRotation< dim, DH >::build_one_patch ( const cell_iterator cell,
internal::DataOutRotation< dim, DH >::ParallelData< DH::dimension, DH::space_dimension > &  data,
std::vector< DataOutBase::Patch< DH::dimension+1, DH::space_dimension+1 > > &  patches 
) [private]

Builds every n_threads's patch. This function may be called in parallel. If multithreading is not used, the function is called once and generates all patches.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:06 by doxygen 1.7.2