amr_wind::pde::PDEFields Struct Reference

#include <PDEFields.H>

Collaboration diagram for amr_wind::pde::PDEFields:

Public Member Functions
	PDEFields (FieldRepo &repo_in, const std::string &var_name)

Public Attributes
FieldRepo &	repo
	Reference to the field repository instance.
Field &	field
	Solution variable (e.g., velocity, temperature)
Field &	mueff
	Effective visocity field (e.g., velocity_mueff)
Field &	src_term
	Source term for this PDE.
Field &	diff_term
	Diffusion term for this PDE.
Field &	conv_term
	Convective term for this PDE.

Detailed Description

Collection of fields related to a PDE

Every PDE requires a common set of fields, e.g., the transported variable (scalar or vector), advection, diffusion, source, and effective viscosity fields. PDEFields is a struct that holds these fields and provides a common way to access these fields regardless of the PDE that is being solved.

The fields are all named in a consistent manner based on the variable name as defined by the PDE trait (e.g., ICNS, Temperature, etc.). For example, if the user is solving the TKE equation, then the field variable is tke and the source term is tke_src_term, and so on.

Constructor & Destructor Documentation

PDEFields()

amr_wind::pde::PDEFields::PDEFields	(	FieldRepo &	repo_in,
		const std::string &	var_name )

Member Data Documentation

conv_term

Field& amr_wind::pde::PDEFields::conv_term

Convective term for this PDE.

diff_term

Field& amr_wind::pde::PDEFields::diff_term

Diffusion term for this PDE.

field

Field& amr_wind::pde::PDEFields::field

Solution variable (e.g., velocity, temperature)

mueff

Field& amr_wind::pde::PDEFields::mueff

Effective visocity field (e.g., velocity_mueff)

repo

FieldRepo& amr_wind::pde::PDEFields::repo

Reference to the field repository instance.

src_term

Field& amr_wind::pde::PDEFields::src_term

Source term for this PDE.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/equation_systems/PDEFields.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/equation_systems/PDEBase.cpp