Adds vtk output fields specific to pore-network models.  
#include <dumux/porenetwork/common/pnmvtkoutputmodule.hh>
|  | 
| using | Field = Vtk::template Field<GridView> | 
|  | the type of Field that can be added to this writer 
 | 
|  | 
| using | VolumeVariables = VV | 
|  | export type of the volume variables for the outputfields 
 | 
|  | 
|  | 
|  | VtkOutputModule (const GridVariables &gridVariables, const SolutionVector &sol, const std::string &name, const std::string ¶mGroup="", Dune::VTK::DataMode dm=Dune::VTK::conforming, bool verbose=true) | 
|  | The constructor. 
 | 
|  | 
| void | addFluxVariable (std::function< Scalar(const FluxVariables &, const FluxVarsCache &)> &&f, const std::string &name) | 
|  | 
| void | write (double time, Dune::VTK::OutputType type=Dune::VTK::ascii) | 
|  | Gather and process all required data and write them to a vtk file. 
 | 
|  | 
| const auto & | problem () const | 
|  | Return a reference to the problem. 
 | 
|  | 
| void | addVelocityOutput (std::shared_ptr< VelocityOutputType > velocityOutput) | 
|  | Add a velocity output policy. 
 | 
|  | 
| void | addVolumeVariable (std::function< Scalar(const VolumeVariables &)> &&f, const std::string &name) | 
|  | 
| template<class VVV = VolVarsVector, typename std::enable_if_t<(VVV::dimension > 1), int > = 0> | 
| void | addVolumeVariable (std::function< VolVarsVector(const VolumeVariables &)> &&f, const std::string &name) | 
|  | 
| const std::string & | paramGroup () const | 
|  | the parameter group for getting parameter from the parameter tree 
 | 
|  | 
| void | addField (const Vector &v, const std::string &name, Vtk::FieldType fieldType=Vtk::FieldType::automatic) | 
|  | Add a scalar or vector valued vtk field. 
 | 
|  | 
| void | addField (const Vector &v, const std::string &name, Dumux::Vtk::Precision precision, Vtk::FieldType fieldType=Vtk::FieldType::automatic) | 
|  | Add a scalar or vector valued vtk field. 
 | 
|  | 
| void | addField (Field &&field) | 
|  | Add a scalar or vector valued vtk field. 
 | 
|  | 
◆ Field
template<class GridVariables, class SolutionVector> 
 
 
◆ VelocityOutput
template<class GridVariables, class SolutionVector> 
 
 
◆ VolumeVariables
template<class GridVariables, class SolutionVector> 
 
 
◆ VtkOutputModule()
template<class GridVariables, class FluxVariables, class SolutionVector> 
  
  | 
        
          | Dumux::PoreNetwork::VtkOutputModule< GridVariables, FluxVariables, SolutionVector >::VtkOutputModule | ( | const GridVariables & | gridVariables, |  
          |  |  | const SolutionVector & | sol, |  
          |  |  | const std::string & | name, |  
          |  |  | const std::string & | paramGroup = "", |  
          |  |  | Dune::VTK::DataMode | dm = Dune::VTK::conforming, |  
          |  |  | bool | verbose = true ) |  | inline | 
 
 
◆ addCellData()
◆ addField() [1/3]
- Parameters
- 
  
    | v | The field to be added. Can be any indexable container. Its value type can be a number or itself an indexable container. |  | name | The name of the field |  | fieldType | The type of the field. This determines whether the values are associated with vertices or elements. By default, the method automatically deduces the correct type for the given input. |  | precision | The output precision of this field (see Dune::VTK::Precision) |  
 
 
 
◆ addField() [2/3]
- Parameters
- 
  
    | v | The field to be added. Can be any indexable container. Its value type can be a number or itself an indexable container. |  | name | The name of the field |  | fieldType | The type of the field. This determines whether the values are associated with vertices or elements. By default, the method automatically deduces the correct type for the given input. |  
 
 
 
◆ addField() [3/3]
- Parameters
- 
  
    | field | The parameters passed on to the field constructor |  
 
 
 
◆ addFluxVariable()
template<class GridVariables, class FluxVariables, class SolutionVector> 
  
  | 
        
          | void Dumux::PoreNetwork::VtkOutputModule< GridVariables, FluxVariables, SolutionVector >::addFluxVariable | ( | std::function< Scalar(const FluxVariables &, const FluxVarsCache &)> && | f, |  
          |  |  | const std::string & | name ) |  | inline | 
 
Output a scalar flux variable related to pore throats. This is basically a wrapper for the ParentType's addField method. 
- Parameters
- 
  
    | f | A function taking a Problem, FluxVariables and FluxVarsCache object and returning the desired scalar |  | name | The name of the vtk field |  
 
 
 
◆ addVelocityOutput()
template<class GridVariables, class SolutionVector> 
 
Methods to conveniently add primary and secondary variables upon initialization Do not call these methods after initialization i.e. not within the time loop
- Parameters
- 
  
    | velocityOutput | the output policy |  
 
- Note
- the default policy does not add any velocity output 
 
 
◆ addVertexData()
◆ addVolumeVariable() [1/2]
template<class GridVariables, class SolutionVector> 
 
Output a scalar volume variable 
- Parameters
- 
  
    | name | The name of the vtk field |  | f | A function taking a VolumeVariables object and returning the desired scalar |  
 
 
 
◆ addVolumeVariable() [2/2]
template<class GridVariables, class SolutionVector> 
template<class VVV = VolVarsVector, typename std::enable_if_t<(VVV::dimension > 1), int > = 0> 
 
Add a vector-valued variable 
- Parameters
- 
  
    | f | A function taking a VolumeVariables object and returning the desired vector |  | name | The name of the vtk field |  
 
- Note
- This method is only available for dimWorld > 1. For 1-D problems, the overload for volVar methods returning a Scalar will be used. 
 
 
◆ dataMode()
◆ fields()
◆ gridGeometry()
template<class GridVariables, class SolutionVector> 
 
 
◆ gridVariables()
template<class GridVariables, class SolutionVector> 
 
 
◆ name()
◆ paramGroup()
◆ precision()
◆ problem()
template<class GridVariables, class FluxVariables, class SolutionVector> 
 
 
◆ sequenceWriter()
◆ sol()
template<class GridVariables, class SolutionVector> 
 
 
◆ velocityOutput()
template<class GridVariables, class SolutionVector> 
 
 
◆ verbose()
◆ volVarScalarDataInfo()
template<class GridVariables, class SolutionVector> 
  
  | 
        
          | const std::vector< VolVarScalarDataInfo > & Dumux::VtkOutputModule< GridVariables, SolutionVector >::volVarScalarDataInfo | ( |  | ) | const |  | inlineprotectedinherited | 
 
 
◆ volVarVectorDataInfo()
template<class GridVariables, class SolutionVector> 
  
  | 
        
          | const std::vector< VolVarVectorDataInfo > & Dumux::VtkOutputModule< GridVariables, SolutionVector >::volVarVectorDataInfo | ( |  | ) | const |  | inlineprotectedinherited | 
 
 
◆ write()
template<class GridVariables, class FluxVariables, class SolutionVector> 
 
 
◆ writer()
◆ addedCellData_
◆ addedVertexData_
The documentation for this class was generated from the following file: