Reference documentation for deal.II version GIT 969cfe8cd8 2022-06-28 20:20:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Protected Attributes | Private Attributes | Related Functions | List of all members
Algorithms::DoFOutputOperator< VectorType, dim, spacedim > Class Template Reference

#include <deal.II/numerics/dof_output_operator.h>

Inheritance diagram for Algorithms::DoFOutputOperator< VectorType, dim, spacedim >:
[legend]

Public Member Functions

 DoFOutputOperator (const std::string &filename_base=std::string("output"), const unsigned int digits=3)
 
void parse_parameters (ParameterHandler &param)
 
void initialize (const DoFHandler< dim, spacedim > &dof_handler)
 
virtual OutputOperator< VectorType > & operator<< (const AnyData &vectors) override
 
void initialize_stream (std::ostream &stream)
 
void set_step (const unsigned int step)
 

Protected Attributes

unsigned int step
 

Private Attributes

SmartPointer< const DoFHandler< dim, spacedim >, DoFOutputOperator< VectorType, dim, spacedim > > dof
 
const std::string filename_base
 
const unsigned int digits
 
DataOut< dim > out
 
std::ostream * os
 

Related Functions

(Note that these are not member functions.)

template<typename VectorType >
OutputOperator< VectorType > & operator<< (OutputOperator< VectorType > &out, unsigned int step)
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

std::atomic< unsigned int > counter
 
std::map< std::string, unsigned int > counter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

Detailed Description

template<typename VectorType, int dim, int spacedim = dim>
class Algorithms::DoFOutputOperator< VectorType, dim, spacedim >

An output operator writing a separate file in each step and writing the vectors as finite element functions with respect to a given DoFHandler.

Definition at line 43 of file dof_output_operator.h.

Constructor & Destructor Documentation

◆ DoFOutputOperator()

template<typename VectorType , int dim, int spacedim = dim>
Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::DoFOutputOperator ( const std::string &  filename_base = std::string("output"),
const unsigned int  digits = 3 
)

Member Function Documentation

◆ parse_parameters()

template<typename VectorType , int dim, int spacedim = dim>
void Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::parse_parameters ( ParameterHandler param)

◆ initialize()

template<typename VectorType , int dim, int spacedim>
void Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::initialize ( const DoFHandler< dim, spacedim > &  dof_handler)
inline

Definition at line 78 of file dof_output_operator.h.

◆ operator<<()

template<typename VectorType , int dim, int spacedim = dim>
virtual OutputOperator<VectorType>& Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::operator<< ( const AnyData vectors)
overridevirtual

Output all the vectors in AnyData.

Reimplemented from Algorithms::OutputOperator< VectorType >.

◆ initialize_stream()

template<typename VectorType >
void Algorithms::OutputOperator< VectorType >::initialize_stream ( std::ostream &  stream)
inherited

Set the stream os to which data is written. If no stream is selected with this function, data goes to deallog.

◆ set_step()

template<typename VectorType >
void Algorithms::OutputOperator< VectorType >::set_step ( const unsigned int  step)
inlineinherited

Set the current step.

Definition at line 152 of file operator.h.

Friends And Related Function Documentation

◆ operator<<()

template<typename VectorType >
OutputOperator< VectorType > & operator<< ( OutputOperator< VectorType > &  out,
unsigned int  step 
)
related

Set the step number in OutputOperator by shifting an integer value.

Definition at line 152 of file operator.h.

Member Data Documentation

◆ dof

template<typename VectorType , int dim, int spacedim = dim>
SmartPointer<const DoFHandler<dim, spacedim>, DoFOutputOperator<VectorType, dim, spacedim> > Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::dof
private

Definition at line 68 of file dof_output_operator.h.

◆ filename_base

template<typename VectorType , int dim, int spacedim = dim>
const std::string Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::filename_base
private

Definition at line 70 of file dof_output_operator.h.

◆ digits

template<typename VectorType , int dim, int spacedim = dim>
const unsigned int Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::digits
private

Definition at line 71 of file dof_output_operator.h.

◆ out

template<typename VectorType , int dim, int spacedim = dim>
DataOut<dim> Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::out
private

Definition at line 73 of file dof_output_operator.h.

◆ step

template<typename VectorType >
unsigned int Algorithms::OutputOperator< VectorType >::step
protectedinherited

Definition at line 144 of file operator.h.

◆ os

template<typename VectorType >
std::ostream* Algorithms::OutputOperator< VectorType >::os
privateinherited

Definition at line 147 of file operator.h.


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