SrcTermOpBase< PDE > Struct Template Reference

AMR-Wind API: amr_wind::pde::SrcTermOpBase< PDE > Struct Template Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
amr_wind::pde::SrcTermOpBase< PDE > Struct Template Reference

#include <PDEOps.H>

Inheritance diagram for amr_wind::pde::SrcTermOpBase< PDE >:
[legend]
Collaboration diagram for amr_wind::pde::SrcTermOpBase< PDE >:
[legend]

Public Member Functions

 SrcTermOpBase (PDEFields &fields_in)
 
void init_source_terms (const CFDSim &sim)
 
void multiply_rho (const FieldState fstate)
 Helper method to multiply the source terms with density.
 
virtual void operator() (const FieldState fstate, const bool)
 Update source terms during time-integration procedure.
 

Public Attributes

PDEFieldsfields
 
Fieldm_density
 
amrex::Vector< std::unique_ptr< typename PDE::SrcTerm > > sources
 

Detailed Description

template<typename PDE>
struct amr_wind::pde::SrcTermOpBase< PDE >

Base implementation of source terms for a PDE

Holds a collection of source terms that are initialized using at runtime based on user inputs. The implementation consults the source_terms input variable within the PDE namespace (e.g., ICNS.source_terms for momentum sources) and initializes them. These source terms are then accumulated into the PDEFields::src_term during solution process.

See also
MomentumSource, TemperatureSource

Constructor & Destructor Documentation

◆ SrcTermOpBase()

template<typename PDE >
amr_wind::pde::SrcTermOpBase< PDE >::SrcTermOpBase ( PDEFields & fields_in)
inlineexplicit

Member Function Documentation

◆ init_source_terms()

template<typename PDE >
void amr_wind::pde::SrcTermOpBase< PDE >::init_source_terms ( const CFDSim & sim)
inline

Initialize the source terms

At this stage the mesh has been created

◆ multiply_rho()

template<typename PDE >
void amr_wind::pde::SrcTermOpBase< PDE >::multiply_rho ( const FieldState fstate)
inline

Helper method to multiply the source terms with density.

◆ operator()()

template<typename PDE >
virtual void amr_wind::pde::SrcTermOpBase< PDE >::operator() ( const FieldState fstate,
const bool  )
inlinevirtual

Update source terms during time-integration procedure.

Reimplemented in amr_wind::pde::SrcTermOp< ICNS >.

Member Data Documentation

◆ fields

template<typename PDE >
PDEFields& amr_wind::pde::SrcTermOpBase< PDE >::fields

◆ m_density

template<typename PDE >
Field& amr_wind::pde::SrcTermOpBase< PDE >::m_density

◆ sources

template<typename PDE >
amrex::Vector<std::unique_ptr<typename PDE::SrcTerm> > amr_wind::pde::SrcTermOpBase< PDE >::sources

The documentation for this struct was generated from the following file:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/equation_systems/PDEOps.H