kynema_sgf::RefinementCriteria Class Reference

#include <RefinementCriteria.H>

Inheritance diagram for kynema_sgf::RefinementCriteria:

Collaboration diagram for kynema_sgf::RefinementCriteria:

Public Member Functions
tagging::TaggingOperator	tag_operator () const
void	tag_operator (const tagging::TaggingOperator &op)
	RefinementCriteria ()=default
	~RefinementCriteria () override=default
virtual void	initialize (const std::string &key)=0
	Perform initialization tasks (e.g., read from file etc.).
virtual void	operator() (int level, amrex::TagBoxArray &tags, amrex::Real time, int ngrow)=0
Public Member Functions inherited from kynema_sgf::Factory< RefinementCriteria, CFDSim & >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	base_identifier ()
Static Public Member Functions inherited from kynema_sgf::Factory< RefinementCriteria, CFDSim & >
static std::unique_ptr< RefinementCriteria >	create (const std::string &key, Args... args)
static void	print (std::ostream &os)

Private Attributes
tagging::TaggingOperator	m_tag_operator {tagging::TaggingOperator::OR}

Additional Inherited Members
Public Attributes inherited from kynema_sgf::Factory< RefinementCriteria, CFDSim & >
friend	Base

Detailed Description

Abstract interface for tagging cells for refinement

This class provides an API that can be used by concrete implementations to tag cells that must be refined based on a pre-defined criteria. The criteria can be a heuristic determined from the solution (e.g., vorticity magnitude or gradients), or some user defined criteria (e.g., static, nested refinements).

Constructor & Destructor Documentation

RefinementCriteria()

kynema_sgf::RefinementCriteria::RefinementCriteria ( )

default

~RefinementCriteria()

kynema_sgf::RefinementCriteria::~RefinementCriteria ( )

overridedefault

Member Function Documentation

base_identifier()

std::string kynema_sgf::RefinementCriteria::base_identifier ( )

inlinestatic

initialize()

virtual void kynema_sgf::RefinementCriteria::initialize ( const std::string & key )

pure virtual

Perform initialization tasks (e.g., read from file etc.).

Called before mesh is initialized

operator()()

virtual void kynema_sgf::RefinementCriteria::operator() ( int level, amrex::TagBoxArray & tags, amrex::Real time, int ngrow )

pure virtual

Perform tagging operation based on refinement criteria

Interface is the same as amrex::AmrCore::ErrorEst

tag_operator() [1/2]

tagging::TaggingOperator kynema_sgf::RefinementCriteria::tag_operator ( ) const

inlinenodiscard

tag_operator() [2/2]

void kynema_sgf::RefinementCriteria::tag_operator ( const tagging::TaggingOperator & op )

inline

Member Data Documentation

m_tag_operator

tagging::TaggingOperator kynema_sgf::RefinementCriteria::m_tag_operator {tagging::TaggingOperator::OR}

private

---

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

• /home/runner/work/kynema-sgf/kynema-sgf/src/utilities/tagging/RefinementCriteria.H