mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction > Class Template Reference

Class for simulating incompressible Schrodinger flow. More...

#include <schrodinger_flow.hpp>

Inheritance diagram for mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >:

Collaboration diagram for mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >:

Public Member Functions
	IncompressibleBaseFlow (Options &config, TSchrodingerSolver &solver)
void	Setup ()
	Setup the solver.
void	Step (const real_t &t)
	This function performs a single time step of the solver.
void	ConstrainJetVelocity ()
	Restricts the velocity of the wavefunctions.

Public Attributes
TSchrodingerSolver &	solver
const int	ndofs
real_t	omega
TGridFunction	isJet
TGridFunction	phase
TGridFunction	vx
TGridFunction	vy
TGridFunction	vz

Detailed Description

template<typename TSchrodingerSolver, typename TGridFunction>
class mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >

Class for simulating incompressible Schrodinger flow.

Definition at line 704 of file schrodinger_flow.hpp.

Constructor & Destructor Documentation

IncompressibleBaseFlow()

template<typename TSchrodingerSolver , typename TGridFunction >

mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::IncompressibleBaseFlow ( Options & config, TSchrodingerSolver & solver )

inline

Definition at line 712 of file schrodinger_flow.hpp.

Member Function Documentation

ConstrainJetVelocity()

template<typename TSchrodingerSolver , typename TGridFunction >

void mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::ConstrainJetVelocity ( )

inline

Restricts the velocity of the wavefunctions.

Definition at line 811 of file schrodinger_flow.hpp.

Setup()

template<typename TSchrodingerSolver , typename TGridFunction >

void mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::Setup ( )

inline

Setup the solver.

This function initializes the solver by setting up the phase, the Jet vectors and normalizing the wave functions. It also adds circular vortex rings if leapfrog is enabled.

Definition at line 733 of file schrodinger_flow.hpp.

Step()

template<typename TSchrodingerSolver , typename TGridFunction >

void mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::Step ( const real_t & t )

inline

This function performs a single time step of the solver.

Definition at line 783 of file schrodinger_flow.hpp.

Member Data Documentation

isJet

template<typename TSchrodingerSolver , typename TGridFunction >

TGridFunction mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::isJet

Definition at line 710 of file schrodinger_flow.hpp.

ndofs

template<typename TSchrodingerSolver , typename TGridFunction >

const int mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::ndofs

Definition at line 708 of file schrodinger_flow.hpp.

omega

template<typename TSchrodingerSolver , typename TGridFunction >

real_t mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::omega

Definition at line 709 of file schrodinger_flow.hpp.

phase

template<typename TSchrodingerSolver , typename TGridFunction >

TGridFunction mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::phase

Definition at line 710 of file schrodinger_flow.hpp.

solver

template<typename TSchrodingerSolver , typename TGridFunction >

TSchrodingerSolver& mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::solver

Definition at line 707 of file schrodinger_flow.hpp.

vx

template<typename TSchrodingerSolver , typename TGridFunction >

TGridFunction mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::vx

Definition at line 710 of file schrodinger_flow.hpp.

vy

template<typename TSchrodingerSolver , typename TGridFunction >

TGridFunction mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::vy

Definition at line 710 of file schrodinger_flow.hpp.

vz

template<typename TSchrodingerSolver , typename TGridFunction >

TGridFunction mfem::IncompressibleBaseFlow< TSchrodingerSolver, TGridFunction >::vz

Definition at line 710 of file schrodinger_flow.hpp.

---

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

• miniapps/fluids/schrodinger-flow/schrodinger_flow.hpp