BaseLib::GradualSubdivision Class Reference

Detailed Description

Gradual subdivision operator with a constant multiplier_

Definition at line 60 of file Subdivision.h.

#include <Subdivision.h>

Inheritance diagram for BaseLib::GradualSubdivision:

Collaboration diagram for BaseLib::GradualSubdivision:

Public Member Functions
	GradualSubdivision (const double L, const double dL0, const double max_dL, const double multiplier)
std::vector< double >	operator() () const override
	Returns a vector of subdivided points.
Public Member Functions inherited from BaseLib::ISubdivision
virtual	~ISubdivision ()=default

Private Attributes
const double	length_
const double	dL0_
const double	max_dL_
const double	multiplier_

Constructor & Destructor Documentation

GradualSubdivision()

BaseLib::GradualSubdivision::GradualSubdivision	(	const double	L,
		const double	dL0,
		const double	max_dL,
		const double	multiplier )

Constructor

Parameters

L	total length to be subdivided
dL0	initial cell length
max_dL	maximum cell length
multiplier	multiplier to cell length

Definition at line 13 of file Subdivision.cpp.

    : length_(L), dL0_(dL0), max_dL_(max_dL), multiplier_(multiplier)
{
    // Check if accumulated subdivisions can ever sum up to length.
    // Cf. geometric series formula.
    if (multiplier < 1.0 && dL0 / (1.0 - multiplier) < L)
    {
        OGS_FATAL(
            "Using dL0={:g} and multiplier={:g} the generated subdivisions can "
            "not sum up to a total length of {:g}.",
            dL0,
            multiplier,
            L);
    }
}

References dL0_, length_, max_dL_, multiplier_, and OGS_FATAL.

Member Function Documentation

operator()()

std::vector< double > BaseLib::GradualSubdivision::operator() ( ) const

overridevirtual

Returns a vector of subdivided points.

Implements BaseLib::ISubdivision.

Definition at line 32 of file Subdivision.cpp.

{
    std::vector<double> vec_x;
 
    double x = 0;
    unsigned i = 0;
    do
    {
        vec_x.push_back(x);
        x += std::min(max_dL_,
                      dL0_ * std::pow(multiplier_, static_cast<double>(i)));
        i++;
    } while (x < length_);
 
    if (vec_x.back() < length_)
    {
        double last_dx = vec_x[vec_x.size() - 1] - vec_x[vec_x.size() - 2];
        if (length_ - vec_x.back() < last_dx)
        {
            vec_x[vec_x.size() - 1] = length_;
        }
        else
        {
            vec_x.push_back(length_);
        }
    }
    return vec_x;
}

References dL0_, length_, max_dL_, and multiplier_.

Member Data Documentation

dL0_

const double BaseLib::GradualSubdivision::dL0_

private

Definition at line 80 of file Subdivision.h.

Referenced by GradualSubdivision(), and operator()().

length_

const double BaseLib::GradualSubdivision::length_

private

Definition at line 79 of file Subdivision.h.

Referenced by GradualSubdivision(), and operator()().

max_dL_

const double BaseLib::GradualSubdivision::max_dL_

private

Definition at line 81 of file Subdivision.h.

Referenced by GradualSubdivision(), and operator()().

multiplier_

const double BaseLib::GradualSubdivision::multiplier_

private

Definition at line 82 of file Subdivision.h.

Referenced by GradualSubdivision(), and operator()().

---

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

• Subdivision.h
• Subdivision.cpp