Arcane  4.1.15.0
User documentation
Loading...
Searching...
No Matches
PoissonModule Class Reference

#include <tutorial/poisson/PoissonModule.h>

Public Member Functions

 PoissonModule (const ModuleBuildInfo &mbi)
 ~PoissonModule ()
virtual void initTemperatures ()
virtual void propagateTemperatures ()
virtual VersionInfo versionInfo () const

Detailed Description

Represents a module that calculates a numerical heat diffusion following Poisson's equation in a parallelepiped.

Definition at line 14 of file PoissonModule.h.

Constructor & Destructor Documentation

◆ PoissonModule()

PoissonModule::PoissonModule ( const ModuleBuildInfo & mbi)
inline

Constructor of the class

Definition at line 18 of file PoissonModule.h.

◆ ~PoissonModule()

PoissonModule::~PoissonModule ( )
inline

Destructor of the class

Definition at line 21 of file PoissonModule.h.

Member Function Documentation

◆ initTemperatures()

void PoissonModule::initTemperatures ( )
virtual

Initializes the temperatures in the mesh based on the temperature provided in the dataset. This method is an entry point of the module registered under the name InitTemperatures.

Definition at line 13 of file PoissonModule.cc.

◆ propagateTemperatures()

void PoissonModule::propagateTemperatures ( )
virtual

Diffuses temperatures in the mesh. This method is an entry point of the module registered under the name PropagateTemperatures.

Definition at line 28 of file PoissonModule.cc.

◆ versionInfo()

virtual VersionInfo PoissonModule::versionInfo ( ) const
inlinevirtual

Returns the version number of the module

Definition at line 40 of file PoissonModule.h.


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