Reference documentation for deal.II version 9.4.1
\(\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\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
DataPostprocessors::BoundaryIds< dim > Class Template Reference

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

Inheritance diagram for DataPostprocessors::BoundaryIds< dim >:
[legend]

Public Member Functions

 BoundaryIds ()
 
virtual void evaluate_scalar_field (const DataPostprocessorInputs::Scalar< dim > &inputs, std::vector< Vector< double > > &computed_quantities) const override
 
virtual std::vector< std::string > get_names () const override
 
virtual std::vector< DataComponentInterpretation::DataComponentInterpretationget_data_component_interpretation () const override
 
virtual UpdateFlags get_needed_update_flags () const override
 
virtual void evaluate_vector_field (const DataPostprocessorInputs::Vector< dim > &input_data, std::vector< Vector< double > > &computed_quantities) const
 

Private Attributes

const std::string name
 
const UpdateFlags update_flags
 

Subscriptor functionality

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

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)
 
std::atomic< unsigned intcounter
 
std::map< std::string, unsigned intcounter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 
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<int dim>
class DataPostprocessors::BoundaryIds< dim >

A concrete data postprocessor class that can be used to output the boundary ids of all faces. This is often useful to identify bugs in the assignment of boundary indicators when reading meshes from input files. See the usage example in the glossary entry on boundary ids to see how this class can be used.

Note
This class is intended for use with DataOutFaces, not DataOut. This is because it provides information about the faces of a triangulation, not about cell-based information.

By default, the DataOutFaces class function only generates output for faces that lie on the boundary of the domain, and on these faces, boundary indicators are available. But one can also instruct DataOutFaces to run on internal faces as well (by providing an argument to the constructor of the class). At these internal faces, no boundary indicator is available because, of course, the face is not actually at the boundary. For these faces, the current class then outputs -1 as an indicator.

Definition at line 1307 of file data_postprocessor.h.

Constructor & Destructor Documentation

◆ BoundaryIds()

template<int dim>
DataPostprocessors::BoundaryIds< dim >::BoundaryIds

Constructor.

Definition at line 202 of file data_postprocessor.cc.

Member Function Documentation

◆ evaluate_scalar_field()

template<int dim>
void DataPostprocessors::BoundaryIds< dim >::evaluate_scalar_field ( const DataPostprocessorInputs::Scalar< dim > &  inputs,
std::vector< Vector< double > > &  computed_quantities 
) const
overridevirtual

The principal function of this class. It puts the boundary id of each face into the appropriate output fields.

Reimplemented from DataPostprocessor< dim >.

Definition at line 209 of file data_postprocessor.cc.

◆ get_names()

template<int dim>
std::vector< std::string > DataPostprocessorScalar< dim >::get_names
overridevirtualinherited

Return the vector of strings describing the names of the computed quantities. Given the purpose of this class, this is a vector with a single entry equal to the name given to the constructor.

Implements DataPostprocessor< dim >.

Definition at line 94 of file data_postprocessor.cc.

◆ get_data_component_interpretation()

template<int dim>
std::vector< DataComponentInterpretation::DataComponentInterpretation > DataPostprocessorScalar< dim >::get_data_component_interpretation
overridevirtualinherited

This function returns information about how the individual components of output files that consist of more than one data set are to be interpreted. Since the current class is meant to be used for a single scalar result variable, the returned value is obviously DataComponentInterpretation::component_is_scalar.

Reimplemented from DataPostprocessor< dim >.

Definition at line 103 of file data_postprocessor.cc.

◆ get_needed_update_flags()

template<int dim>
UpdateFlags DataPostprocessorScalar< dim >::get_needed_update_flags
overridevirtualinherited

Return, which data has to be provided to compute the derived quantities. The flags returned here are the ones passed to the constructor of this class.

Implements DataPostprocessor< dim >.

Definition at line 112 of file data_postprocessor.cc.

◆ evaluate_vector_field()

template<int dim>
void DataPostprocessor< dim >::evaluate_vector_field ( const DataPostprocessorInputs::Vector< dim > &  input_data,
std::vector< Vector< double > > &  computed_quantities 
) const
virtualinherited

Same as the evaluate_scalar_field() function, but this function is called when the original data vector represents vector data, i.e., the finite element in use has multiple vector components. This function is also called if the finite element is scalar but the solution vector is complex-valued. If the solution vector to be visualized is complex-valued (whether scalar or not), then the input data contains first all real parts of the solution vector at each evaluation point, and then all imaginary parts.

Definition at line 60 of file data_postprocessor.cc.

Member Data Documentation

◆ name

template<int dim>
const std::string DataPostprocessorScalar< dim >::name
privateinherited

Copies of the two arguments given to the constructor of this class.

Definition at line 779 of file data_postprocessor.h.

◆ update_flags

template<int dim>
const UpdateFlags DataPostprocessorScalar< dim >::update_flags
privateinherited

Definition at line 780 of file data_postprocessor.h.


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