TimeInterpolatedData Struct Reference

#include <ERF_TimeInterpolatedData.H>

Collaboration diagram for TimeInterpolatedData:

Public Member Functions
	TimeInterpolatedData ()=default
	TimeInterpolatedData (double time)
	~TimeInterpolatedData ()
	TimeInterpolatedData (TimeInterpolatedData &&other) noexcept
TimeInterpolatedData &	operator= (TimeInterpolatedData &&other) noexcept
	TimeInterpolatedData (const TimeInterpolatedData &other)=delete
TimeInterpolatedData &	operator= (const TimeInterpolatedData &other)=delete
void	set_time (double time)
double	get_time () const
void	add_var (amrex::MultiFab *var_data, int own_data)
amrex::MultiFab &	get_var (int var_idx)
int	num_vars ()
void	clear ()

Private Attributes
amrex::Vector< amrex::MultiFab * >	m_data
amrex::Vector< int >	m_owns_data
double	m_time = 0.0

Constructor & Destructor Documentation

TimeInterpolatedData() [1/4]

TimeInterpolatedData::TimeInterpolatedData ( )

default

Construct empty time-interpolated data storage.

TimeInterpolatedData() [2/4]

TimeInterpolatedData::TimeInterpolatedData ( double  time )

inline

Construct storage associated with a time.

Parameters

[in]

time

time associated with the data

: m_time(time) {}

~TimeInterpolatedData()

TimeInterpolatedData::~TimeInterpolatedData ( )

inline

Destroy owned data and clear internal storage.

                             {
        clear();
    }

Here is the call graph for this function:

TimeInterpolatedData() [3/4]

TimeInterpolatedData::TimeInterpolatedData ( TimeInterpolatedData &&  other )

inlinenoexcept

Move constructor: takes over the source's data and ownership, leaving it empty.

Parameters

[in]

other

source object

        : m_data(std::move(other.m_data)),
          m_owns_data(std::move(other.m_owns_data)),
          m_time(other.m_time)
    {
        other.m_data.clear();
        other.m_owns_data.clear();
    }

TimeInterpolatedData() [4/4]

TimeInterpolatedData::TimeInterpolatedData ( const TimeInterpolatedData &  other )

delete

Deleted copy constructor.

Parameters

[in]

other

source object

Member Function Documentation

add_var()

void TimeInterpolatedData::add_var ( amrex::MultiFab *  var_data, int  own_data  )

inline

Add a MultiFab pointer to the managed list.

Parameters

[in]	var_data	MultiFab pointer to store
[in]	own_data	whether this object owns and deletes var_data

                                                         {
        m_data.push_back(var_data);
        m_owns_data.push_back(own_data);
    }

clear()

void TimeInterpolatedData::clear ( )

inline

Clear stored data, deleting entries owned by this object.

                  {
        // clear all data owned by this object
        for (int i = 0; i < num_vars(); ++i) {
            if (m_owns_data[i] == 1) {
                m_data[i]->clear();
                delete m_data[i];
            }
        }
 
        // clear internal memory
        m_data.clear();
        m_owns_data.clear();
        m_time = 0.0;
    }

Referenced by operator=(), and ~TimeInterpolatedData().

Here is the call graph for this function:

Here is the caller graph for this function:

get_time()

double TimeInterpolatedData::get_time ( ) const

inline

Return the time associated with the data.

{ return m_time; }

get_var()

amrex::MultiFab& TimeInterpolatedData::get_var ( int  var_idx )

inline

Return one stored MultiFab.

Parameters

[in]

var_idx

index of the stored MultiFab

                                         {
        return *m_data[var_idx];
    }

num_vars()

int TimeInterpolatedData::num_vars ( )

inline

Return the number of stored MultiFabs.

{ return m_data.size(); }

Referenced by clear().

Here is the caller graph for this function:

operator=() [1/2]

TimeInterpolatedData& TimeInterpolatedData::operator= ( const TimeInterpolatedData &  other )

delete

Deleted copy-assignment operator.

Parameters

[in]

other

source object

operator=() [2/2]

TimeInterpolatedData& TimeInterpolatedData::operator= ( TimeInterpolatedData &&  other )

inlinenoexcept

Move-assignment operator: frees the data this object owns, then takes over the source's data and ownership, leaving it empty.

Parameters

[in]

other

source object

                                                                            {
        if (this != &other) {
            clear();
            m_data      = std::move(other.m_data);
            m_owns_data = std::move(other.m_owns_data);
            m_time      = other.m_time;
            other.m_data.clear();
            other.m_owns_data.clear();
        }
        return *this;
    }

Here is the call graph for this function:

set_time()

void TimeInterpolatedData::set_time ( double  time )

inline

Set the time associated with the data.

Parameters

[in]

time

time associated with the data

                                {
        m_time = time;
    }

Member Data Documentation

m_data

amrex::Vector<amrex::MultiFab*> TimeInterpolatedData::m_data

private

Referenced by add_var(), clear(), get_var(), num_vars(), and operator=().

m_owns_data

amrex::Vector<int> TimeInterpolatedData::m_owns_data

private

Referenced by add_var(), clear(), and operator=().

m_time

double TimeInterpolatedData::m_time = 0.0

private

Referenced by clear(), get_time(), operator=(), and set_time().

---

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

• Source/BoundaryConditions/ERF_TimeInterpolatedData.H