ABLATE Source Documentation  0.12.36
Classes | Public Member Functions | Static Public Member Functions | List of all members
ablate::finiteVolume::processes::EVTransport Class Reference

#include <evTransport.hpp>

+ Inheritance diagram for ablate::finiteVolume::processes::EVTransport:

Public Member Functions

 EVTransport (std::shared_ptr< eos::EOS > eos, std::shared_ptr< fluxCalculator::FluxCalculator > fluxCalcIn={}, std::shared_ptr< eos::transport::TransportModel > transportModel={})
 
void Setup (ablate::finiteVolume::FiniteVolumeSolver &flow) override
 
- Public Member Functions inherited from ablate::finiteVolume::processes::Process
virtual void Initialize (ablate::finiteVolume::FiniteVolumeSolver &fv)
 

Static Public Member Functions

static void BoundExtraVariables (TS ts, ablate::solver::Solver &solver, const std::string &field)
 
static void BoundExtraVariablesMinusOneToOne (TS ts, ablate::solver::Solver &solver, const std::string &field)
 
static void PositiveExtraVariables (TS ts, ablate::solver::Solver &solver, const std::string &field)
 
static PetscErrorCode UpdateEVField (PetscReal time, PetscInt dim, const PetscFVCellGeom *cellGeom, const PetscInt uOff[], const PetscScalar *conservedValues, const PetscInt *aOff, PetscScalar *auxField, void *ctx)
 
static PetscErrorCode UpdateBoundEVField (PetscReal time, PetscInt dim, const PetscFVCellGeom *cellGeom, const PetscInt uOff[], const PetscScalar *conservedValues, const PetscInt *aOff, PetscScalar *auxField, void *ctx)
 
static PetscErrorCode UpdateMinusOneToOneBoundEVField (PetscReal time, PetscInt dim, const PetscFVCellGeom *cellGeom, const PetscInt uOff[], const PetscScalar *conservedValues, const PetscInt *aOff, PetscScalar *auxField, void *ctx)
 
static PetscErrorCode UpdatePositiveEVField (PetscReal time, PetscInt dim, const PetscFVCellGeom *cellGeom, const PetscInt uOff[], const PetscScalar *conservedValues, const PetscInt *aOff, PetscScalar *auxField, void *ctx)
 

Detailed Description

This class is used to transport any arbitrary extra variable (EV) with a given diffusion coefficient. The variable are assumed to be stored in a conserved form in the solution vector and a non conserved form in the aux vector. This is applied to all fields tagged as an ev

Member Function Documentation

◆ BoundExtraVariables()

void ablate::finiteVolume::processes::EVTransport::BoundExtraVariables ( TS  ts,
ablate::solver::Solver &  solver,
const std::string &  field 
)
static

Enforce extra variables to be between zero and one

Parameters
ts

◆ BoundExtraVariablesMinusOneToOne()

void ablate::finiteVolume::processes::EVTransport::BoundExtraVariablesMinusOneToOne ( TS  ts,
ablate::solver::Solver &  solver,
const std::string &  field 
)
static

Enforce extra variables to be between minus one and one

Parameters
ts

◆ PositiveExtraVariables()

void ablate::finiteVolume::processes::EVTransport::PositiveExtraVariables ( TS  ts,
ablate::solver::Solver &  solver,
const std::string &  field 
)
static

Enforce extra variables to be zero or greater

Parameters
ts

◆ Setup()

void ablate::finiteVolume::processes::EVTransport::Setup ( ablate::finiteVolume::FiniteVolumeSolver &  flow)
overridevirtual

public function to link this process with the flow

Parameters
flow

Implements ablate::finiteVolume::processes::Process.

◆ UpdateBoundEVField()

PetscErrorCode ablate::finiteVolume::processes::EVTransport::UpdateBoundEVField ( PetscReal  time,
PetscInt  dim,
const PetscFVCellGeom *  cellGeom,
const PetscInt  uOff[],
const PetscScalar *  conservedValues,
const PetscInt *  aOff,
PetscScalar *  auxField,
void *  ctx 
)
static

Function to compute the EV fraction. This function assumes that the input values will be {"euler", "densityYi"} with values between zero and one

◆ UpdateEVField()

PetscErrorCode ablate::finiteVolume::processes::EVTransport::UpdateEVField ( PetscReal  time,
PetscInt  dim,
const PetscFVCellGeom *  cellGeom,
const PetscInt  uOff[],
const PetscScalar *  conservedValues,
const PetscInt *  aOff,
PetscScalar *  auxField,
void *  ctx 
)
static

Function to compute the EV fraction. This function assumes that the input values will be {"euler", "densityYi"}

◆ UpdateMinusOneToOneBoundEVField()

PetscErrorCode ablate::finiteVolume::processes::EVTransport::UpdateMinusOneToOneBoundEVField ( PetscReal  time,
PetscInt  dim,
const PetscFVCellGeom *  cellGeom,
const PetscInt  uOff[],
const PetscScalar *  conservedValues,
const PetscInt *  aOff,
PetscScalar *  auxField,
void *  ctx 
)
static

Function to compute the EV fraction. This function assumes that the input values will be {"euler", "densityYi"} with values between minus one and one

◆ UpdatePositiveEVField()

PetscErrorCode ablate::finiteVolume::processes::EVTransport::UpdatePositiveEVField ( PetscReal  time,
PetscInt  dim,
const PetscFVCellGeom *  cellGeom,
const PetscInt  uOff[],
const PetscScalar *  conservedValues,
const PetscInt *  aOff,
PetscScalar *  auxField,
void *  ctx 
)
static

Function to compute the EV fraction. This function assumes that the input values will be {"euler", "densityYi"} with values zero or greater

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