Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
ScalarFunctionPostprocessor< dim > Class Template Reference

#include <postprocessors.h>

Inheritance diagram for ScalarFunctionPostprocessor< dim >:
[legend]

Public Member Functions

 ScalarFunctionPostprocessor (std::string name, const std::shared_ptr< Function< dim > > scalar_function)
virtual void evaluate_vector_field (const DataPostprocessorInputs::Vector< dim > &input_data, std::vector< Vector< double > > &computed_quantities) const override

Private Attributes

std::shared_ptr< Function< dim > > scalar_function

Detailed Description

template<int dim>
class ScalarFunctionPostprocessor< dim >

Compute a scalar field for a given function within a domain.

Definition at line 561 of file postprocessors.h.

Constructor & Destructor Documentation

◆ ScalarFunctionPostprocessor()

template<int dim>
ScalarFunctionPostprocessor< dim >::ScalarFunctionPostprocessor ( std::string name,
const std::shared_ptr< Function< dim > > scalar_function )
inline

Constructor of the scalar function postprocessor.

Parameters
[in]nameName of the outputted field.
[in]scalar_functionPostprocessing scalar function.

Definition at line 572 of file postprocessors.h.

References scalar_function.

Member Function Documentation

◆ evaluate_vector_field()

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

Compute the scalar given by the postprocessing function at given evaluation points.

Parameters
[in]input_dataIndependent variable of the postprocessing function.
[out]computed_quantitiesComputed scalar value at evaluation points.

Definition at line 589 of file postprocessors.h.

References scalar_function.

Member Data Documentation

◆ scalar_function

template<int dim>
std::shared_ptr<Function<dim> > ScalarFunctionPostprocessor< dim >::scalar_function
private

Scalar postprocessing function.

Definition at line 607 of file postprocessors.h.


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