smith::ParaviewWriter Class Reference

Class which interactions with ParaViewDataCollection to write arbitrary field results to disk. This allows output independent of a particular BasePhysics. More...

#include <paraview_writer.hpp>

Classes
struct	Options
	Options that control which fields are written to ParaView output. More...

Public Types
using	StateVecs = std::vector< std::shared_ptr< FiniteElementState > >
	using

Public Member Functions
	ParaviewWriter (std::unique_ptr< mfem::ParaViewDataCollection > pv_, const StateVecs &states_, const StateVecs &tracked_reactions_)
	Construct a writer backed by an existing ParaView data collection. More...
	ParaviewWriter (std::unique_ptr< mfem::ParaViewDataCollection > pv_, const StateVecs &states_, const StateVecs &tracked_reactions_, Options opts_)
	Construct a writer backed by an existing ParaView data collection with explicit output options. More...
void	write (size_t step, double time, const std::vector< const FiniteElementState * > &current_states)
	write paraview output from vector of finite element states. states must be passed in with a consistent order as how the ParaviewWriter was constructed (consistent order of spaces)
void	write (size_t step, double time, const std::vector< const FiniteElementDual * > &current_duals)
	write paraview output from vector of finite element duals. duals must be passed in with a consistent order as how the ParaviewWriter was constructed (consistent order of spaces)
void	write (int step, double time, const std::vector< FieldState > &current_fields)
	write paraview output from vector of FieldState. These must be passed in with a consistent order as how the ParaviewWriter was constructed (consistent order of spaces). Both the field, and its dual/reaction will be written.
void	write (size_t step, double time, const std::vector< FieldState > &current_fields)
	overload

Detailed Description

Class which interactions with ParaViewDataCollection to write arbitrary field results to disk. This allows output independent of a particular BasePhysics.

Definition at line 25 of file paraview_writer.hpp.

Constructor & Destructor Documentation

ParaviewWriter() [1/2]

smith::ParaviewWriter::ParaviewWriter ( std::unique_ptr< mfem::ParaViewDataCollection >  pv_, const StateVecs &  states_, const StateVecs &  tracked_reactions_  )

inline

Construct a writer backed by an existing ParaView data collection.

Parameters

[in]	pv_	ParaView data collection that owns the output database.
[in]	states_	Output state fields that will be updated before each write.
[in]	tracked_reactions_	Output dual fields that will be updated before each write.

Definition at line 39 of file paraview_writer.hpp.

ParaviewWriter() [2/2]

smith::ParaviewWriter::ParaviewWriter ( std::unique_ptr< mfem::ParaViewDataCollection >  pv_, const StateVecs &  states_, const StateVecs &  tracked_reactions_, Options  opts_  )

inline

Construct a writer backed by an existing ParaView data collection with explicit output options.

Parameters

[in]	pv_	ParaView data collection that owns the output database.
[in]	states_	Output state fields that will be updated before each write.
[in]	tracked_reactions_	Output dual fields that will be updated before each write.
[in]	opts_	Options that control which fields are emitted.

Definition at line 50 of file paraview_writer.hpp.

---

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

• src/smith/differentiable_numerics/paraview_writer.hpp