amr_wind::FieldRefinement Class Reference

#include <FieldRefinement.H>

Inheritance diagram for amr_wind::FieldRefinement:

Collaboration diagram for amr_wind::FieldRefinement:

Public Member Functions
	FieldRefinement (const CFDSim &sim)
	~FieldRefinement () override=default
void	initialize (const std::string &key) override
	Read input file and initialize boxarray used to refine each level.
void	operator() (const int level, amrex::TagBoxArray &tags, const amrex::Real time, const int ngrow) override
template<typename MF >
void	tag (const int level, amrex::TagBoxArray &tags, const MF &mfab)

Static Public Member Functions
static std::string	identifier ()

Private Attributes
const CFDSim &	m_sim
Field *	m_field {nullptr}
IntField *	m_int_field {nullptr}
amrex::Vector< amrex::Real >	m_field_error
amrex::Vector< amrex::Real >	m_grad_error
int	m_max_lev_field {-1}
int	m_max_lev_grad {-1}
amrex::RealBox	m_tagging_box

Detailed Description

AMR refinement using a given field (e.g., density)

tagging.labels = t1
tagging/t1.type = FieldRefinement
tagging/t1.field_name = density
# Tagging based on field value
# tagging/t1.field_error = 10.0 10.0
 
# Tagging based on local gradient
tagging/t1.grad_error = 0.1 0.1 0.1

Constructor & Destructor Documentation

FieldRefinement()

amr_wind::FieldRefinement::FieldRefinement ( const CFDSim & sim )

explicit

~FieldRefinement()

amr_wind::FieldRefinement::~FieldRefinement ( )

overridedefault

Member Function Documentation

identifier()

static std::string amr_wind::FieldRefinement::identifier ( )

inlinestatic

initialize()

void amr_wind::FieldRefinement::initialize ( const std::string & key )

override

Read input file and initialize boxarray used to refine each level.

operator()()

void amr_wind::FieldRefinement::operator() ( const int level, amrex::TagBoxArray & tags, const amrex::Real time, const int ngrow )

override

tag()

template<typename MF >

void amr_wind::FieldRefinement::tag ( const int level, amrex::TagBoxArray & tags, const MF & mfab )

inline

Member Data Documentation

m_field

Field* amr_wind::FieldRefinement::m_field {nullptr}

private

m_field_error

amrex::Vector<amrex::Real> amr_wind::FieldRefinement::m_field_error

private

m_grad_error

amrex::Vector<amrex::Real> amr_wind::FieldRefinement::m_grad_error

private

m_int_field

IntField* amr_wind::FieldRefinement::m_int_field {nullptr}

private

m_max_lev_field

int amr_wind::FieldRefinement::m_max_lev_field {-1}

private

m_max_lev_grad

int amr_wind::FieldRefinement::m_max_lev_grad {-1}

private

m_sim

const CFDSim& amr_wind::FieldRefinement::m_sim

private

m_tagging_box

amrex::RealBox amr_wind::FieldRefinement::m_tagging_box

private

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/tagging/FieldRefinement.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/tagging/FieldRefinement.cpp