由Roy Stogner创作 2012年更多...

#include <const_function.h>

类 libMesh::ConstFunction< Output > 继承关系图:

Public 成员函数
	ConstFunction (const Output &c)
	构造函数，用于初始化常量值。更多...

	ConstFunction (ConstFunction &&)=default
	该类可以使用默认的移动构造和分配。更多...

	ConstFunction (const ConstFunction &)=default

ConstFunction &	operator= (const ConstFunction &)=default

ConstFunction &	operator= (ConstFunction &&)=default

virtual	~ConstFunction ()=default
	默认析构函数。更多...

virtual Output	operator() (const Point &, const Real=0) override
	重载操作符，用于计算标量值。更多...

virtual void	operator() (const Point &, const Real, DenseVector< Output > &output) override
	重载操作符，用于计算矢量值。更多...

virtual std::unique_ptr < FunctionBase< Output > >	clone () const override
	克隆函数。创建并返回一个与当前实例相同类型的新实例。更多...

virtual void	init ()
	实际的初始化过程。更多...

virtual void	clear ()
	清除函数。更多...

void	operator() (const Point &p, DenseVector< Output > &output)
	Evaluation function for time-independent vector-valued functions. 更多...

virtual Output	component (unsigned int i, const Point &p, Real time=0.)

bool	initialized () const

void	set_is_time_dependent (bool is_time_dependent)
	设置函数是否依赖时间的函数。这仅应该由无法本地确定时间依赖性的子类使用。在这种情况下，应在构造之后立即使用这个函数。更多...

bool	is_time_dependent () const

Protected 属性
const FunctionBase *	_master
	指向我们的主函数对象的const指针，初始化为 `nullptr。` 可能存在需要多个函数的情况，但为了节省内存，一个主函数对象可以处理一些集中的数据。更多...

bool	_initialized
	当 `init()` 被调用以确保一切都准备好后，可以调用 `operator()` (...) 时为 `true。` 更多...

bool	_is_time_dependent
	成员变量用于缓存函数是否真正依赖于时间。更多...

Private 属性
Output	_c

详细描述

template<typename Output = Number>
class libMesh::ConstFunction< Output >

由Roy Stogner创作 2012年

返回始终不变的单一值的函数。

在文件 const_function.h 第 41 行定义.

构造及析构函数说明

template<typename Output = Number>

libMesh::ConstFunction< Output >::ConstFunction ( const Output & c )

inlineexplicit

构造函数，用于初始化常量值。

参数

c 返回的常量值。

在文件 const_function.h 第 49 行定义.

参考 libMesh::FunctionBase< Output >::_initialized , 以及 libMesh::FunctionBase< Output >::_is_time_dependent.

                                    : _c(c)
   {
     // 将initialized标记为true，表示初始化完成
     this->_initialized = true;
     // 将is_time_dependent标记为false，表示该函数不依赖于时间
     this->_is_time_dependent = false;
   }

template<typename Output = Number>

libMesh::ConstFunction< Output >::ConstFunction ( ConstFunction< Output > && )

default

该类可以使用默认的移动构造和分配。

template<typename Output = Number>

libMesh::ConstFunction< Output >::ConstFunction ( const ConstFunction< Output > & )

default

template<typename Output = Number>

virtual libMesh::ConstFunction< Output >::~ConstFunction ( )

virtualdefault

默认析构函数。

成员函数说明

template<typename Output>

virtual void libMesh::FunctionBase< Output >::clear ( )

inlinevirtualinherited

清除函数。

这个函数可以用来清除函数对象的状态，以备重新使用。

被 libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T > , 以及 libMesh::AnalyticFunction< Output > 重载.

在文件 function_base.h 第 95 行定义.

95 {}

template<typename Output = Number>

virtual std::unique_ptr<FunctionBase<Output> > libMesh::ConstFunction< Output >::clone ( ) const

inlineoverridevirtual

克隆函数。创建并返回一个与当前实例相同类型的新实例。

返回: 新实例的指针。

实现了 libMesh::FunctionBase< Output >.

被 libMesh::ZeroFunction< Output > 重载.

在文件 const_function.h 第 100 行定义.

参考 libMesh::ConstFunction< Output >::_c.

   {
     return std::make_unique<ConstFunction<Output>>(_c);
   }

template<typename Output >

Output libMesh::FunctionBase< Output >::component	(	unsigned int	i,
		const Point &	p,
		Real	time = `0.`
	)

inlinevirtualinherited

返回: 用于时间相关的矢量值函数的评估函数,在坐标 p 和时间 time 处的向量分量 i。

注解: 子类不需要重写这个函数，因为默认实现基于完整向量评估，通常是正确的。; 推荐子类重写这个函数，因为默认实现基于向量评估，通常是不必要的低效率。; 默认实现调用带有大小为 i+1 的DenseVector的operator()，如果operator()在该限制之外进行访问，将导致意外行为。

参数

p	坐标点。
time	时间。
output	输出的向量。

被 libMesh::CompositeFunction< Output >, libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T > , 以及 libMesh::WrappedFunction< Output > 重载.

在文件 function_base.h 第 240 行定义.

 {
   DenseVector<Output> outvec(i+1);
   (*this)(p, time, outvec);
   return outvec(i);
 }

template<typename Output>

virtual void libMesh::FunctionBase< Output >::init ( )

inlinevirtualinherited

实际的初始化过程。

这个函数可以用来进行函数对象的初始化工作。

被 libMesh::ParsedFunction< Output, OutputGradient >, libMesh::ParsedFunction< T > , 以及 libMesh::AnalyticFunction< Output > 重载.

在文件 function_base.h 第 89 行定义.

89 {}

template<typename Output >

bool libMesh::FunctionBase< Output >::initialized ( ) const

inlineinherited

返回: 在坐标 p 和时间 time 处的向量的分量 i。

子类可以选择重写这个函数以提高效率，因为默认实现基于向量评估，通常是不必要的低效率。

参数

i	分量的索引。
p	坐标点。
time	时间。

注解: 默认实现调用带有大小为 i+1 的DenseVector的operator()，如果operator() 在该限制之外进行访问，将导致意外行为。

在文件 function_base.h 第 216 行定义.

 {
   return (this->_initialized);
 }

template<typename Output >

bool libMesh::FunctionBase< Output >::is_time_dependent ( ) const

inlineinherited

返回: 当前对象表示的函数是否实际上是时间相关的，是返回 true ，否则返回 false。

这个函数用于查询函数对象是否依赖于时间。有些函数对象的时间依赖性是从外部确定的，因此可以使用这个函数设置。

在文件 function_base.h 第 232 行定义.

参考自 libMesh::CompositeFunction< Output >::attach_subfunction().

 {
   return (this->_is_time_dependent);
 }

template<typename Output = Number>

virtual Output libMesh::ConstFunction< Output >::operator()	(	const Point &	,
		const Real	= `0`
	)

inlineoverridevirtual

重载操作符，用于计算标量值。

参数

p	计算点的坐标。
time	时间值，默认为0。

返回: 计算得到的标量值。

实现了 libMesh::FunctionBase< Output >.

在文件 const_function.h 第 76 行定义.

参考 libMesh::ConstFunction< Output >::_c.

78 { return _c; }

libMesh::ConstFunction::_c

Output _c

Definition: const_function.h:106

template<typename Output = Number>

virtual void libMesh::ConstFunction< Output >::operator()	(	const Point &	,
		const Real	,
		DenseVector< Output > &	output
	)

inlineoverridevirtual

重载操作符，用于计算矢量值。

参数

p	计算点的坐标。
time	时间值。
output	计算得到的矢量值。

实现了 libMesh::FunctionBase< Output >.

在文件 const_function.h 第 86 行定义.

参考 libMesh::ConstFunction< Output >::_c , 以及 libMesh::DenseVector< T >::size().

   {
     // 将输出矢量的每个分量设置为常量值
     unsigned int size = output.size();
     for (unsigned int i=0; i != size; ++i)
       output(i) = _c;
   }

template<typename Output>

void libMesh::FunctionBase< Output >::operator()	(	const Point &	p,
		DenseVector< Output > &	output
	)

inlineinherited

Evaluation function for time-independent vector-valued functions.

Sets output values in the passed-in output DenseVector.

在文件 function_base.h 第 252 行定义.

 {
   // 调用时间相关的函数，时间设为0。
   this->operator()(p, 0., output);
 }

template<typename Output = Number>

ConstFunction& libMesh::ConstFunction< Output >::operator= ( const ConstFunction< Output > & )

default

template<typename Output = Number>

ConstFunction& libMesh::ConstFunction< Output >::operator= ( ConstFunction< Output > && )

default

template<typename Output >

void libMesh::FunctionBase< Output >::set_is_time_dependent ( bool is_time_dependent )

inlineinherited

设置函数是否依赖时间的函数。这仅应该由无法本地确定时间依赖性的子类使用。在这种情况下，应在构造之后立即使用这个函数。

在文件 function_base.h 第 224 行定义.

 {
   this->_is_time_dependent = is_time_dependent;
 }

类成员变量说明

template<typename Output = Number>

Output libMesh::ConstFunction< Output >::_c

private

在文件 const_function.h 第 106 行定义.

参考自 libMesh::ConstFunction< Output >::clone() , 以及 libMesh::ConstFunction< Output >::operator()().

template<typename Output>

bool libMesh::FunctionBase< Output >::_initialized

protectedinherited

当 init() 被调用以确保一切都准备好后，可以调用 operator() (...) 时为 true。

这个成员变量用于跟踪函数对象是否已经完成初始化，如果已经准备好进行评估，则为 true。

在文件 function_base.h 第 191 行定义.

参考自 libMesh::AnalyticFunction< Output >::AnalyticFunction(), libMesh::ConstFunction< Output >::ConstFunction(), libMesh::ParsedFunction< Output, OutputGradient >::ParsedFunction() , 以及 libMesh::WrappedFunction< Output >::WrappedFunction().

template<typename Output>

bool libMesh::FunctionBase< Output >::_is_time_dependent

protectedinherited

成员变量用于缓存函数是否真正依赖于时间。

在文件 function_base.h 第 197 行定义.

参考自 libMesh::CompositeFunction< Output >::attach_subfunction() , 以及 libMesh::ConstFunction< Output >::ConstFunction().

template<typename Output>

const FunctionBase* libMesh::FunctionBase< Output >::_master

protectedinherited

指向我们的主函数对象的const指针，初始化为 nullptr。 可能存在需要多个函数的情况，但为了节省内存，一个主函数对象可以处理一些集中的数据。

这个成员变量用于指向主函数对象的指针，有时候多个函数对象需要共享一些数据，可以通过主函数对象来管理。

在文件 function_base.h 第 184 行定义.

该类的文档由以下文件生成:

/home/lwz/libmesh/include/numerics/const_function.h

Public 成员函数

Protected 属性

Private 属性

详细描述

template<typename Output = Number> class libMesh::ConstFunction< Output >

构造及析构函数说明

成员函数说明

类成员变量说明

template<typename Output = Number>
class libMesh::ConstFunction< Output >